Skip to main content
GET
List user statuses

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Query Parameters

limit
integer
default:20

Page size, 1 to 100. Out-of-range values are clamped and the value used is echoed in pagination.limit. A value that is not a whole number, such as abc or 1.5, is rejected with 400 VALIDATION.INVALID_PARAMETER. An empty value gives the default.

Example:

20

cursor
string

Opaque cursor from a previous page's pagination.next. Pass it back unchanged. An empty value starts at the first page. Keep the same filters across pages. A cursor this API did not issue is rejected with 400 PAGINATION.INVALID_CURSOR.

status
enum<string>

Only users with this live status.

Available options:
online,
idle,
offline,
on_call,
after_call_work
updatedSince
string<date-time>

RFC 3339 time. Only users whose updatedAt is strictly after it.

Example:

"2026-11-02T11:00:00Z"

Response

One page of user statuses.

data
object[]
required
pagination
object
required
requestId
string
required