SIsigmacomputing
Tenants

List tenant organizations

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.
get/v2/tenants

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Query parameters

pageTokenstring

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

pageSizeinteger

Number of results to return per page, with a maximum of 1000. Defaults to 50.

key'createdAt' | 'createdBy' | 'name' | 'url'

Field to sort the results by

order'asc' | 'desc'

Sort order for the results

searchstring

Search term to filter tenant organizations by slug or creator

Response

The response body.

nextPageTokenstring

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.

Changes

No recorded changes to this operation across all 1 revision of this API.