> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gosentrix.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Tenants

> Manage tenant information

Manage tenant information and settings.

## List Tenants

<RequestExample>
  ```bash theme={null}
  curl -X GET https://cp.gosentrix.io/api/v1/tenants \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "results": [
      {
        "id": "tenant-123",
        "name": "My Company",
        "slug": "my-company",
        "status": "active",
        "created_at": "2024-01-01T00:00:00Z"
      }
    ],
    "count": 1
  }
  ```
</ResponseExample>

## Get Tenant

<RequestExample>
  ```bash theme={null}
  curl -X GET https://cp.gosentrix.io/api/v1/tenants/{tenant_id} \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ```
</RequestExample>

## Update Tenant

<RequestExample>
  ```bash theme={null}
  curl -X PATCH https://cp.gosentrix.io/api/v1/tenants/{tenant_id} \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Updated Company Name"
    }'
  ```
</RequestExample>

## Response Fields

<ResponseField name="id" type="string">
  Tenant UUID
</ResponseField>

<ResponseField name="name" type="string">
  Tenant name
</ResponseField>

<ResponseField name="slug" type="string">
  Tenant URL slug
</ResponseField>

<ResponseField name="status" type="string">
  Tenant status (active, suspended, etc.)
</ResponseField>

<ResponseField name="created_at" type="string">
  ISO 8601 creation timestamp
</ResponseField>

## Notes

* Requires tenant admin role
* Some operations may require step-up authentication
* See [Tenancy Model](/concepts/tenancy-model) for details