Sigma REST APITenants

List tenant organizations

View as Markdown
Retrieve a paginated list of tenant organizations with optional filtering and sorting. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - Use **pageToken** and **pageSize** parameters to manage paginated responses. - Use **search** to filter results by organization slug or ID of the user who created the tenant. - Use **key** and **order** to sort results by creation date, ID of the user who created the tenant, name, or URL.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pageTokenstringOptional

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeintegerOptional
Number of results to return per page, with a maximum of 1000. Defaults to 50.
keyenumOptional
Field to sort the results by
Allowed values:
orderenumOptional
Sort order for the results
Allowed values:
searchstringOptional
Search term to filter tenant organizations by slug or creator

Response

The response body.
entrieslist of nullable objects
Array of results returned by the endpoint
nextPageTokenstringOptional

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.