Groups
The Group model
id
String
The unique identifier for the group which is given by Tiledesk.
name
String
The group name.
members
Array
The group members.
trashed
Boolean
Determine if the group is deleted.
attributes
Object
The custom attributes which are set for the group.
createdAt
String
The time when the group was created.
updatedAt
String
The time when the group was updated.
createdBy
String
The unique identifier of the row creator.
id_project
String
The unique identifier of the project.
Get all groups
GET https://api.tiledesk.com/v3/:project_id/groups
Allows an account to list all the groups of the project.
Path parameters:
project_id (string): the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers:
Authorization (string): authorization token. Basic Auth or JWT
Successful response (200) — example:
Example:
Get the group by id
GET https://api.tiledesk.com/v3/:project_id/groups/:id
Fetch the group by its id.
Path parameters:
project_id (string): the Project Id is a unique code assigned to your project when you create it in Tiledesk.
id (string): the group identifier
Headers:
Authorization (string): authorization token. Basic Auth or JWT
Successful response (200) — example:
Example:
Create a new group
POST https://api.tiledesk.com/v3/:project_id/groups
Allows to add more groups.
Path parameters:
project_id (string): The project_id is a unique code assigned to your project when you create it in Tiledesk.
Headers:
Authorization (string): authorization token. Basic Auth or JWT
Content-Type (string): use "application/json"
Request body:
name (string): The group name
members (array): The group members ids.
Successful response (200) — example:
Example:
Update a group
PUT https://api.tiledesk.com/v3/:project_id/groups/:id
Allows to update a group.
Path parameters:
project_id (string): The project_id is a unique code assigned to your project when you create it in Tiledesk.
id (string): The group identifier
Headers:
Authorization (string): authorization token. Basic Auth or JWT
Content-Type (string): use "application/json"
Request body:
name (string): The group name
members (array): The group members ids.
Successful response (200) — example:
Example:
Delete a group
DELETE https://api.tiledesk.com/v3/:project_id/groups/:id
Allows to delete a group.
Path parameters:
project_id (string): The project_id is a unique code assigned to your project when you create it in Tiledesk.
id (string): The group identifier
Headers:
Authorization (string): authorization token. Basic Auth or JWT
Successful response (200) — example:
Example: