Grouping agents and tickets help you manage Desk Platform more efficiently. With the Grou* 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 Settings > Teams on the Sendbird Dashboard. Note that the term Group is referred to as Team on the dashboard.
Note: To see which group a specific ticket belongs to, use the Ticket API instead.
Resource representation
The following table shows the list of properties in a group resource.
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. The key can be a mix of lowercase letters, hyphens, underscores, or 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
string
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.
Actions
API endpoints are relative to the base URL allocated to your application. In this page, the /groups endpoint refers to https://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.