Get users

get/identity/v1/users

Retrieve list of users with filtering, and pagination options. All users are returned when no filters are provided. Note: User view all permission is required to invoke this API. Rate limit: 300 requests per minute per workspace, resulting in a 429 error if exceeded.

SecurityBearerAuth
Request
query Parameters
filter
string (Filter)
Default: ""

Filter data using a subset of OData 4.0 and return only the subset of resources that match the filter.

Supported classes and examples include:

  • Types: timestamp, string
  • Comparison: eq, ne, gt, ge, lt
  • Logical Expressions: and, or, not

The Get users API can be filtered by:

  • id
  • username
  • userStatus
  • createdAt
  • updatedAt
  • lastLogin

userStatus can be one of the following:

  • UNVERIFIED
  • VERIFIED
  • BLOCKED
  • DELETE_IN_PROGRESS
  • DELETED
  • SUSPENDED

Note: The userStatus filter is case-sensitive.

Examples:
Returns the user with a specific ID.
filter=id eq '7600415a-8876-5722-9f3c-b0fd11112283'
Returns the user with a specific username.
filter=username eq 'user@example.com'
Returns users that are not unverified.
filter=userStatus ne 'UNVERIFIED'
Returns users created after 2020-09-21T14:19:09.769747
filter=createdAt gt '2020-09-21T14:19:09.769747'
Returns users updated after 2020-09-21T14:19:09.769747
filter=updatedAt gt '2020-09-21T14:19:09.769747'
Returns users that logged in before 2020-09-21T14:19:09.769747
filter=lastLogin lt '2020-09-21T14:19:09.769747'
Returns the user with a specific email.
filter=username eq 'user@example.com'
limit
integer (Pagination limit) [ 1 .. 600 ]
Default: 300

Specify the maximum number of entries per page. NOTE: The maximum value accepted is 600.

offset
integer (Pagination offset) >= 0
Default: 0

Specify pagination offset. An offset argument defines how many pages to skip before returning results.

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

412

Precondition Failed

422

Unprocessable Entity

500

Internal Server Error

Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "count": 0,
  • "total": 0,
  • "items": [
    ]
}