v1
latestOpenAPI 3.0.02026-07-23620132.5 KBList users
Retrieves a collection of all users for a team or an organization with a given ID. Returned users are sorted by id in descending order.
Query parameters
The unique ID of the organization whose users will be retrieved. If this parameter is set, the teamId parameter must be skipped. For each request either teamId or organizationId must be defined.
The unique ID of the team whose users will be retrieved. If this parameter is set, the organizationId parameter must be skipped. For each request either teamId or organizationId must be defined.
Optional filter parameter.
Optional filter parameter.
Optional filter parameter. If this parameter is set, the teamId parameter must be set as well.
Optional filter parameter. If this parameter is set, the organizationId parameter must be set as well.
Filter by team ID. Use 0 to find users not assigned to any team. Requires organizationId.
Optional filter parameter. Restricts the result to users whose ID is in the given list.
The user's two-factor authentication (TFA) status. This field is available only on plans that have the TFA enforcement enabled.
An array of columns that should be returned from the API. Can be used to save bandwidth when not all properties are needed.
The value that will be used to sort returned entities by. Users can be sorted by name, id and email.
The sorting order. It accepts the ascending and descending direction specifiers.
The number of entities you want to skip before getting entities you want.
The maximum number of entities you want to get in the response.
Response
Successful response