Skip to main content
GET
/
v1
/
tenants
/
{tenantId}
Get tenant
curl --request GET \
  --url https://api.example.com/v1/tenants/{tenantId}

​
Overview

Returns the full details of a specific tenant, including its settings and current status. Required role: Any authenticated user from the same tenant

​
Path parameters

​
tenantId
string
required
The unique identifier of the tenant to retrieve. Example: ten_01HX9VTPQR3KF8MZWBYD5N6JCE.

​
Response

Returns 200 OK with the full tenant object. 
{
  "tenantId": "ten_01HX9VTPQR3KF8MZWBYD5N6JCE",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "status": "active",
  "plan": "pro",
  "createdAt": "2026-01-15T09:30:00Z",
  "settings": {
    "awsRoleArn": "arn:aws:iam::123456789012:role/CauseFlowRole",
    "awsExternalId": "causeflow-ext-id-acme",
    "awsRegion": "us-east-1",
    "autoRemediation": false
  }
}
FieldTypeDescription
tenantIdstringUnique identifier for the tenant
namestringThe tenant display name
slugstringThe URL-safe tenant identifier
statusstringTenant status: active or suspended
planstringThe subscription plan: starter, pro, business, or enterprise
createdAtstringISO 8601 timestamp of when the tenant was created
settings.awsRoleArnstringARN of the AWS IAM role used for AWS integrations
settings.awsExternalIdstringExternal ID used when assuming the AWS IAM role
settings.awsRegionstringPrimary AWS region for this tenant’s infrastructure
settings.autoRemediationbooleanWhether automatic remediation execution is enabled

​
Error responses

StatusError codeDescription
403forbiddenThe authenticated user does not belong to this tenant
404not_foundNo tenant exists with the provided tenantId

​
Examples

curl https://api.causeflow.ai/v1/tenants/ten_01HX9VTPQR3KF8MZWBYD5N6JCE \
  -H "Authorization: Bearer <token>"