Sign in

v1

latestOpenAPI 3.0.12026-08-064278250.7 KB
users

Retrieve users

Retrieve a list of users in a workspace. This call supports pagination; default page size includes 20 users.

get/v1/users

Query parameters

emailstring

Filter by a user’s email address. This is not case sensitive.

Filter by a user’s email address. This is not case sensitive.

namestring

Filter by a user’s name. This is not case sensitive.

Filter by a user’s name. This is not case sensitive.

pagestring

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

pageSizestring

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

Headers

Workspacestring required

The workspace identifier, which isolates API requests inside the provided workspace scope.

Response

Success

totalElementsinteger

The total number of records that exist for the request.

Example response

{
  "items": [
    {
      "id": "62ff9653efef4b3ae04ab25e",
      "email": "test@test.com",
      "name": "Harry Owen"
    }
  ]
}