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}

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