---
title: "List tenant organizations"
method: GET
path: "/v2/tenants"
tags: ["Tenants"]
---

# List tenant organizations

`GET /v2/tenants`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/tenants`
- Auth: HTTP bearer

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.

## Query parameters

- `pageToken` string
- `pageSize` integer
- `key` 'createdAt' | 'createdBy' | 'name' | 'url': Field to sort the results by
- `order` 'asc' | 'desc': Sort order for the results
- `search` string

## Response `200`

The response body.

- TenantsListTenantsResponse200
  - `entries` V2TenantsGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `tenantOrganizationId` string, required: Unique identifier of the tenant organization
    - `parentOrganizationId` string, required: Unique identifier of the tenant's parent organization
    - `createdBy` string, required: Unique identifier of the user who created the tenant organization
    - `updatedBy` string, required: Unique identifier of the user who last updated the tenant organization
    - `createdAt` string, date-time, required: Timestamp when the tenant organization was created. Format: ISO 8601 timestamp
    - `updatedAt` string, date-time, required: Timestamp when the tenant organization was last updated. Format: ISO 8601 timestamp
    - `tenantOrganizationName` string, required: Name of the tenant organization to create
    - `tenantOrganizationSlug` string, required: URL identifier for the tenant organization
    - `sharedAt` string, date-time: Timestamp when the tenant organization was shared, if applicable. Format: ISO 8601 timestamp
    - `tenantCloudProvider` string: Cloud provider the tenant organization is hosted on
    - `tenantRegion` string: Region the tenant organization is hosted in
    - `tenantApiUrl` string: Base URL for accessing the tenant organization API
  - `nextPageToken` string: 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.**

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)
