Docs
/
/

List users

Retrieve a paginated list of users in the environment. Defaults to 50 users per page.

List users

Retrieve a paginated list of users in the environment. Defaults to 50 users per page.

Endpoint

GET/v1/users

Rate limit

Tier 4

Query parameters

include[]
enum(string)[]

Associated resources to include in the response.

preferences
after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

page_size
integer

The number of items per page (defaults to 50).

Returns

ListUsersResponse

A paginated list of users.

entries

A list of users.

__typename
string
Required

The typename of the schema.

avatar
string

A URL for the avatar of the user.

created_at
string(date-time)

The creation date of the user from your system.

email
string

The primary email address for the user.

id
string
Required

The unique identifier of the user.

name
string

Display name of the user.

phone_number
string

The E.164 phone number of the user (required for SMS channels).

timezone
string

The timezone of the user. Must be a valid tz database time zone string. Used for recurring schedules.

updated_at
string(date-time)
Required

The timestamp when the resource was last updated.

page_info

Pagination information for a list of resources.

__typename
string

The typename of the schema.

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

page_size
integer

The number of items per page (defaults to 50).

New chat