List customers

GET https://desk-api-{{APP_ID}}.sendbird.com/platform/v1/customers

List customers

Retrieves a list of customers registered in the application.

For more information, visit:

https://sendbird.com/docs/desk/v1/platform-api/guides/customer#2-list-customers

URL Parameters

Required

Request Params

KeyDatatypeRequiredDescription
limitstringOPTIONAL: Specifies the number of results to return per page. Acceptable values are 1 to 500, inclusive. (Default: 50)
offsetstringOPTIONAL: 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)
sendbird_idstringOPTIONAL: Specifies the user ID of the target customer including IDs in Sendbird Chat platform and social media.

HEADERS

KeyDatatypeRequiredDescription
SENDBIRDDESKAPITOKENstring