API DocsRESTUser service

ListActiveUsers

List active users.

GET
/api/v2/users

Query Parameters

pageSizeinteger

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"

pageTokenstring

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

filterstring

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.

organizationIdstring

Optional. If provided, this will scope down the user search to just those in the organization ID provided.

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

A successful response.

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

Previous

GetUser GET

Next

UpdateUserOrganizationActive POST