ListUsers

GET

/api/v2/users:all

Query Parameters

`pageSize`integer

The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

Format: "int64"

`pageToken`string

A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUsers must match the call that provided the page token. Optional.

`filter`string

A Common Expression Language (CEL) filter string. Available fields to filter by are user_id and name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

`orderBy`string

How to order the retrieved users. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are:

created_date
modified_date

curl -X GET "<API_URL>/api/v2/users:all?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "users": [
    {
      "userId": "string",
      "userName": "string",
      "organizations": [
        {
          "organizationId": "string",
          "organizationName": "string"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Query Parameters

pageSizeinteger

pageTokenstring

filterstring

orderBystring

Response

`pageSize`integer

`pageToken`string

`filter`string

`orderBy`string