Skip to main content
GET
/
api
/
v1
/
tenants
curl -X GET https://cp.gosentrix.io/api/v1/tenants \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "results": [
    {
      "id": "tenant-123",
      "name": "My Company",
      "slug": "my-company",
      "status": "active",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "count": 1
}
Manage tenant information and settings.

​
List Tenants

curl -X GET https://cp.gosentrix.io/api/v1/tenants \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "results": [
    {
      "id": "tenant-123",
      "name": "My Company",
      "slug": "my-company",
      "status": "active",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "count": 1
}

​
Get Tenant

curl -X GET https://cp.gosentrix.io/api/v1/tenants/{tenant_id} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Update Tenant

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"
  }'

​
Response Fields

​
id
string
Tenant UUID
​
name
string
Tenant name
​
slug
string
Tenant URL slug
​
status
string
Tenant status (active, suspended, etc.)
​
created_at
string
ISO 8601 creation timestamp

​
Notes

  • Requires tenant admin role
  • Some operations may require step-up authentication
  • See Tenancy Model for details