List tenant organizations (Beta)

GET

/v2/tenants

GET

/v2/tenants

$ curl https://api.sigmacomputing.com/v2/tenants \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "tenantOrganizationId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "parentOrganizationId": "f1e2d3c4-b5a6-7890-cd12-ef34ab567890",
6       "createdBy": "user-1234567890abcdef",
7       "updatedBy": "user-0987654321fedcba",
8       "createdAt": "2024-01-15T09:30:00Z",
9       "updatedAt": "2024-04-10T14:45:00Z",
10       "tenantOrganizationName": "Acme Analytics",
11       "tenantOrganizationSlug": "acme-analytics",
12       "sharedAt": "2024-02-01T12:00:00Z",
13       "tenantCloudProvider": "AWS",
14       "tenantRegion": "us-west-2",
15       "tenantApiUrl": "https://acme-analytics.us-west-2.aws.sigmacomputing.com"
16     }
17   ],
18   "nextPageToken": "eyJwYWdlIjoxfQ=="
19 }

Retrieve a paginated list of tenant organizations with optional filtering and sorting.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

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.

Retrieve a paginated list of tenant organizations with optional filtering and sorting. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### 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

pageSizeintegerOptional

keyenumOptional

Field to sort the results by

Allowed values:

orderenumOptional

Sort order for the results

Allowed values:

searchstringOptional

Response

The response body.

entrieslist of nullable objects

Array of results returned by the endpoint

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.