Skip to content
JITSudo Docs

List tenants

GET
/v1/tenants
 
curl --request GET \
  --url 'https://example.com/v1/tenants?limit=50' \
  --header 'X-API-Key: <X-API-Key>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50 <= 250

Maximum number of items to return.

cursor
string

Opaque pagination cursor from a previous response. Omit for the first page.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
name
required
string
slug
required
string
locale
required

Default locale for the tenant (e.g. ‘en’, ‘fr’).

string
owner_email

Email address of the tenant owner.

string
nullable
owner_user_id

UUID of the tenant’s owner user.

string format: uuid
nullable
sso_start_url

AWS IAM Identity Center start URL for SSO login.

string
nullable
sso_region

AWS region of the IAM Identity Center instance.

string
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
is_master
required

Whether this tenant is the master (platform) tenant.

boolean
primary_domain

First verified domain for this tenant, if any.

string
nullable
next_cursor
string
nullable
has_more
required
boolean
Example generated
{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "slug": "example",
      "locale": "example",
      "owner_email": "example",
      "sso_start_url": "example",
      "sso_region": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "updated_at": "2026-04-15T12:00:00Z"
    }
  ],
  "next_cursor": "example",
  "has_more": true
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}