Skip to main content
GET
https://{teamSlug}.teams.auth0.com
/
api
/
tenants
/
{tenantId}
Retrieve all metadata for a specific tenant, including domain, environment, locality, and creation date
curl --request GET \
  --url https://{teamSlug}.teams.auth0.com/api/tenants/{tenantId} \
  --header 'Authorization: Bearer <token>'
{
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_name": "<string>",
  "domain": "<string>",
  "environment": "<string>",
  "locality": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "environment_tag": "development"
}

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.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
tenantId
string<uuid>
required

The unique ID of the tenant to retrieve (UUID format) Unique identifier of the tenant

Response

Tenant details retrieved successfully, including tenant ID, name, domain, environment, locality, environment type, and creation date.

​
tenant_id
string<uuid>
required

Unique identifier of the tenant

​
tenant_name
string
required

The tenant name uniquely identifies a tenant programmatically and within various dashboards, such as Auth0 Dashboard. It can only contain alphanumeric characters, lowercase letters and "-". However, it can't start nor end with "-". If not specified, a tenant name will be auto-generated.

Required string length: 3 - 63
Pattern: ^[a-z0-9][-a-z0-9]{1,62}[a-z0-9]$
Example:

"acme-development-tenant"

​
domain
string
required

The fully qualified domain name of the tenant, which uniquely identifies its domain within the system. The domain is used to define the audience when interacting with the Management API, enabling programmatic management of the tenant’s configuration and resources.

Examples:

"acme-development-tenant.us.auth0.com"

"acme-development-tenant.acme-dev.auth0app.com"

​
environment
string
required

The name of the cloud environment where the tenant was created

Examples:

"US-3"

"EU-1"

"acme-dev"

​
locality
string
required

Locality in which the tenant was created

Examples:

"us"

"eu"

"virginia"

"frankfurt"

​
created_at
string<date-time>
required

The date and time when the tenant was created, formatted in ISO 8601 standard. This timestamp ensures consistency across time zones and systems

​
environment_tag
enum<string>

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

Available options:
development,
production,
staging
Example:

"development"