Skip to main content

Detail Tenant by ID

This API returns detailed information about a specific tenant identified by ID.

Endpoint Details

URL/v1/auth/tenants/id
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific tenant, use the following request format:

/v1/auth/tenants/319a6060-fa5b-436b-95a5-77214d3d5c7d

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the tenant

Response

Here is an example of a response when viewing data details:

Response
{
"tenant": {
"id": "319a6060-fa5b-436b-95a5-77214d3d5c7d",
"name": "dummy",
"slug": "dummy",
"status": "active",
"owner_user_id": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_at": 1784187547,
"updated_at": 1784187547
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the tenant
nameStringName of the tenant
slugStringUnique slug identifier of the tenant
statusStringCurrent status of the tenant
owner_user_idUUIDIdentifier of the user who owns the tenant
descriptionStringDescription of the tenant
created_byUUIDIdentifier of the user who created the tenant
updated_byUUIDIdentifier of the user who last updated the tenant
created_atIntegerCreation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing tenant.
  • The description field may not be present if the tenant was created without a description.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.