Detail Tenant by ID
This API returns detailed information about a specific tenant identified by ID.
Endpoint Details
| URL | /v1/auth/tenants/id |
| Method | GET |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must 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
| Parameter | Type | Description |
|---|---|---|
| id | UUID | Unique 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
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the tenant |
| name | String | Name of the tenant |
| slug | String | Unique slug identifier of the tenant |
| status | String | Current status of the tenant |
| owner_user_id | UUID | Identifier of the user who owns the tenant |
| description | String | Description of the tenant |
| created_by | UUID | Identifier of the user who created the tenant |
| updated_by | UUID | Identifier of the user who last updated the tenant |
| created_at | Integer | Creation timestamp in Unix format |
| updated_at | Integer | Last update timestamp in Unix format |
info
- A valid Bearer Token is required to access this endpoint.
- The
idpath parameter must reference an existing tenant. - The
descriptionfield 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.