Passer au contenu principal
GET
https://{teamSlug}.teams.auth0.com
/
api
/
tenants
List all tenants under the current team
curl --request GET \
  --url https://{teamSlug}.teams.auth0.com/api/tenants \
  --header 'Authorization: Bearer <token>'
{
  "tenants": [
    {
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_name": "<string>",
      "environment": "<string>",
      "domain": "<string>",
      "locality": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "environment_tag": "development"
    }
  ],
  "next": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs-dev.auth0-mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

take
integer
défaut:50

Maximum number of items to return per page. Defaults to 50. Maximum 50

Plage requise: 1 <= x <= 50
from
string

Checkpoint cursor for pagination; use the 'next' value from a previous response to fetch the next page

sort
string
défaut:created_at:-1

Sort order for results using MongoDB-style syntax. Defaults to 'created_at:-1' (newest first, descending). Use 'created_at:1' for oldest first (ascending). Format: field:direction where direction is 1 (ascending) or -1 (descending).

Pattern: ^created_at:(1|-1)$
environment
string

Filter tenants by environment. For public cloud tenants, use the short name (e.g., 'US-3', 'EU-1'). For private cloud tenants, use the space name (e.g., 'acme-dev').

Minimum string length: 1
environment_tag
enum<string>

Filter tenants by environment tag Specifies the Environment tag for the tenant created in the Auth0 Public Cloud. It is used to distinguish between development, staging and production environments.
Development and Staging environments are intended for testing and pre-production use, while production is designated for live applications and subject to higher rate limits. Selecting the correct environment type ensures appropriate resource allocation and rate limits

Options disponibles:
development,
production,
staging
Exemple:

"development"

locality
string

Filter tenants by locality. For public cloud tenants, matches locality (e.g., 'us', 'eu'). For private cloud tenants, matches the space's primary locality (e.g., 'virginia', 'frankfurt').

Minimum string length: 1

Réponse

A paginated list of tenants, including tenant details such as ID, name, domain, locality, environment, and creation date. The response also includes a 'next' field for checkpoint-based pagination

tenants
object[]
requis
next
string

Opaque cursor for next page; not sent if no more results