Get users

Returns a list of users in the workspace and their details, with support for sorting and pagination.

Query Params
boolean | null

When true, deleted users are included in the response. Defaults to false.

int32 | null
≥ 0

Returns a specific page of results, starting from page 0. Use with page[size] to control how many items are returned per page. For example, if page[size] is 20, then page[number]=2 returns items 21-40.

int32 | null
≥ 0

Controls how many items are returned in each response page.

int32 | null
≥ 0

Skips the specified number of items before starting the result set. For example, if page[offset] is 30 and page[size] is 10, the response returns items 31-40.

sort
array of strings | null

Sorts the list of users by one or more fields. Prefix a field name with a minus sign (-) to sort in descending order. Repeat the parameter to sort by multiple fields. Supported fields include:

  • fullName
  • email
  • createdAt
  • updatedAt
  • invitedAt
sort
Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json