Skip to main content
POST
List customers
Required scopes: customers:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
page_id
string

Pagination token.

limit
integer
default:10

Maximum number of records per page.

Required range: x <= 100
sort_order
enum<string>
default:desc

Sort order.

Available options:
asc,
desc
sort_by
enum<string>
default:created_at

Sort by field. When sorting by fields other than created_at, entries with identical values are additionally sorted by creation time.

Available options:
created_at,
threads_count,
visits_count,
agent_last_event,
customer_last_event
filters
object

Customer filters.

Response

200 - application/json

Customers.

customers
object[]
total_customers
integer

Total number of customers.

limited_customers
integer

Number of customers hidden due to license limits.

next_page_id
string

Pagination token for the next page.

previous_page_id
string

Pagination token for the previous page.