v1
latestOpenAPI 3.1.02026-07-24145580597.0 KBGet users
Retrieves a list of all users associated with the account. Optionally, filter by user ID to receive specific user information
Query parameters
The maximum number of results to display per page
The maximum number of results to display per page
The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
An enumeration.
Sort key
Sort order, set only if sort key is set
List of user IDs for filtering.
List of user IDs for filtering.
An enumeration.
Filter users by status. Default is active.
List of full names to filter by. Specify the exact first and last name with a space between them as shown in the platform (ignore capitalization).
List of full names to filter by. Specify the exact first and last name with a space between them as shown in the platform (ignore capitalization).
List of phone numbers to filter by (in format +<country code><phone number>).
List of phone numbers to filter by (in format +<country code><phone number>).
List of email addresses to filter by (in format test@test.com).
List of email addresses to filter by (in format test@test.com).
Parameter specifying the date in Unix format (in seconds). Only users created after this date will be included in the results.
Parameter specifying the date in Unix format (in seconds). Only users created after this date will be included in the results.
Parameter specifying the date in in Unix format (in seconds). Only users with fields updated after this date will be included in the results.
Parameter specifying the date in in Unix format (in seconds). Only users with fields updated after this date will be included in the results.
Parameter specifying the date in in Unix format (in seconds). Only users who's logged in after this date will be included in the results.
Parameter specifying the date in in Unix format (in seconds). Only users who's logged in after this date will be included in the results.
Parameter specifying the date in Unix format (in seconds). Only users archived after this date will be included in the results.
Parameter specifying the date in Unix format (in seconds). Only users archived after this date will be included in the results.
Response
Successful Response