Skip to content

Retrieve a tenant.

Method

GET https://papi.afi.ai/api/v1/tenants/{id}

Description

Retrieves a tenant by its ID.

Path params
id string required

ID of the tenant to retrieve.

 
curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{id}
Successful response (200) schema
object

Tenant describes a single tenant.
id string

Unique ID of the tenant.
external_id string

External (Google Workspace, Microsoft 365, etc.) ID of the tenant.
kind string

Tenant kind (`gsuite` for Google Workspace, `o365` for Microsoft 365, etc.).
name string

Tenant name. For Google Workspace and Microsoft 365 tenants, this is typically the domain name.
region string

Region where the tenant resides. Two-letter country or territory code in accordance with ISO 3166-1 alpha-2 (for example, US, CA, AU, UK, EU).
deleted boolean

True if the tenant has been terminated and can no longer be queried. Deleted tenant subscriptions use the `canceled` state.
Response example
{
  "id": "string",
  "external_id": "string",
  "kind": "string",
  "name": "string",
  "region": "string",
  "deleted": true
}