Returns a list of users on the platform.

get

https://cti.example.com/api/v2/users

Required permissions

read users

Optional permissions

read groups Required to access the groups associated with a user
read permissions Required to access the permissions associated with a user
read roles Required to access the roles associated with a user
read sources Required to access the sources associated with a user

Query Params

limit

int32

≥ 1

Maximum number of items to be returned

offset

int32

≥ 0

Return results starting from the specified (zero-based) index

sort

string

Comma-separated list of fields to sort on. Prefix a field with the minus "-" sign if you intend to apply descending sorting to it

data

boolean

Set this parameter to false if you want to only retrieve the number of objects matching the query

attributes

string

Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. data.title

filter[username]

string

Filter by user name

filter[email]

string

Filter by user email

filter[first_name]

string

Filter by first name

filter[last_name]

string

Filter by last name

filter[status]

string

enum

Filter by status

Allowed:

filter[has_mfa_activated]

boolean

Filter by multi-factor authentication status

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The requested object(s)

401Unauthorized request

403Missing permissions