Skip to main content

Get Tenant Details

Get tenant details by ID. This endpoint retrieves detailed information about a specific tenant. Tenant admins can view their own tenant information.


Endpoint

Method: GET URL: {{base_url}}/api/v1/admin/tenants/{tenantId}


Authentication

This endpoint uses Bearer Token authentication via a JWT (JSON Web Token). The token must be included in the Authorization header.


Headers

HeaderDescriptionRequired
AuthorizationBearer token (JWT) for authenticationYes
acceptSpecifies acceptable response formats (application/json)Yes
x-tenantidUUID identifying the tenant/organizationYes
realmnameThe authentication realm nameNo

Path Parameters

ParameterTypeDescriptionRequired
tenantIdstring (UUID)The unique identifier of the tenantYes

Query Parameters

None.


Request Body Schema

Not applicable — this is a GET request with no request body.


Example cURL

curl --request GET \
--url '{{base_url}}/api/v1/admin/tenants/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'accept: application/json' \
--header 'authorization: Bearer {{access_token}}' \
--header 'x-tenantid: {{tenant_id}}'

Success Response Example

Status Code: 200 OK

{
"success": true,
"message": "Tenant details retrieved successfully",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Acme Corporation",
"displayName": "Acme Corp",
"serverUrl": "https://acme.rezolve.ai",
"realmName": "acme-realm",
"status": "active",
"settings": {
"ssoEnabled": true,
"mfaRequired": false,
"sessionTimeout": 3600,
"passwordPolicy": "strong"
},
"subscription": {
"plan": "enterprise",
"usersLimit": 500,
"expiresAt": "2026-07-10T00:00:00.000Z"
},
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2025-07-10T14:00:00.000Z"
},
"timestamp": "2025-07-10T14:20:00.000Z"
}

Error Responses

Status CodeErrorDescription
400 Bad RequestInvalid tenant IDThe tenantId is not a valid UUID
401 UnauthorizedAuthentication failedBearer token is missing, expired, or invalid
403 ForbiddenInsufficient permissionsUser lacks permission to view this tenant
404 Not FoundTenant not foundNo tenant exists with the specified ID
500 Internal Server ErrorServer errorUnexpected server-side error

Notes

  1. Self-Access: Tenant admins can view their own tenant details.

  2. Cross-Tenant: Super admins can view any tenant's details.

  3. Required Roles: Requires tenant_admin or super_admin role.