- Updated : Aug 13, 2020
- TOC
1. Quick start
1.1 Base URL
The base URL used for all APIs is formatted as:
https://desk-api-{app_id}.sendbird.com/platform/v1/
1.2 Headers
A typical request to the Desk Platform API includes the following headers:
SENDBIRDDESKAPITOKEN: {DESK_API_TOKEN}
- Sendbird Desk API Token: an API token is required to identify and authenticate your Sendbird application. To get the Desk API Token for your application, sign in to Sendbird Dashboard, select the application, go to Settings > Desk > Credentials, and create a new token.
1.3 Request example
$ curl -i -H "SENDBIRDDESKAPITOKEN: {token}" \\ 'https://desk-api-{app_id}.sendbird.com/platform/v1/agents?limit=5'$
2. API references
2.1 List agents
Retrieves a list of the agents registered in your Sendbird application.
2.1.1 HTTP request
[GET] https://desk-api-{app_id}.sendbird.com/platform/v1/agents/
2.1.2 Optional parameters
- limit (int): Specifies the number of results returned per page. Acceptable values are 1 to 500, inclusive. (Default: 50)