Grouping agents and tickets help you manage Desk Platform more efficiently. With the Group API, you can retrieve a list of groups or view a specific group along with the agents belonging to it. Creating a new group is only available in the Sendbird Dashboard.
Note: To see which group a specific ticket belongs to, use the Ticket API instead.
| Property name | Type | Description |
|---|---|---|
id | int | The unique ID of the group. |
name | string | The name of the group. |
key | string | The unique key of the group. Values can be a mix of lowercase letters, hyphen, underscore, and numbers. |
project | int | The unique ID of a Desk project where the agent belongs. Desk projects have their own corresponding Sendbird application on a one-to-one basis. |
createdAt | datetime | The date and time when the group was created, in ISO 8601 format. |
createdBy | string | The ID of an agent who created this group. |
description | string | The description of the group. |
- API endpoints are relative to the base URL allocated to your application. In this page, the
/groupsendpoint refers tohttps://desk-api-{application_id}.sendbird.com/platform/v1/groups.
Note: If you want to know your application ID, sign in to your dashboard, go to the Settings > Application > General, and then check the Application ID.
| Action | HTTP request |
|---|---|
| |
|
Retrieves a list of groups in the application.
GET https://desk-api-{application_id}.sendbird.com/platform/v1/groups
The following table lists the parameters that this action supports.
Parameters
| Optional | Type | Description |
|---|---|---|
limit | int | Specifies the number of results to return per page. Acceptable values are 1 to 500, inclusive. (Default: 50) |
int | Specifies the number of results to skip before retrieving the next page in the result set. This is used to adjust the starting index of the next page. (Default: 0) |
Query string example
?limit=5&offset=10
If successful, this action returns a list of group resources in the response body.
Status: 200 OK
{
"count": 65,
"previous": "https://desk-api-xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx.sendbird.com/platform/v1/groups?limit=5&offset=5",
"next": "https://desk-api-xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx.sendbird.com/platform/v1/groups?limit=5&offset=15",
"results": [
{
"id": 13,
"name": "CS Team",
"key": "Customer Support",
"project": 13,
"createdAt": "2019-05-03T02:28:13.264936Z",
"createdBy": 27,
"description": "Customer support team"
},
... # More groups
]
}
| Property name | Type | Description |
|---|---|---|
count | int | The total count of groups in the application. |
previous | string | The URL to retrieve the previous page in the result set. |
next | string | The URL to retrieve the next page in the result set. |
results[] | list | A list of groups. |
Retreives information on a specific group.
GET https://desk-api-{application_id}.sendbird.com/platform/v1/groups/{group_id}
The following table lists the parameters that this action supports.
Parameters
| Required | Type | Description |
|---|---|---|
group_id | int | Specifies the unique ID of the target group. |
If successful, this action returns a group resource with the information of agents and tickets within the group in the response body.
Status: 200 OK
{
"id": 77,
"name": "DATW Team",
"key": "DATW",
"project": 13,
"createdAt": "2019-05-03T02:28:13.264936Z",
"createdBy": 27,
"description": "Jeff's team",
"members": [
{
"id": 28,
"displayName": "Julia",
"email": "julia_cake@sendbird.com",
"photoThumbnailUrl": "https://file-staging.sendbird.com/profile_images/smile_julia.png"
},
... # More agents
]
}