Skip to content

Retrieve a tenant

Method

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

Description

Retrieves tenant object 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 single tenant object.
id string

Unique ID of the tenant.
external_id string

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

Kind of the tenant (gsuite for Google Workspace, o365 for Microsoft 365 etc.).
name string

Tenant name. Domain name for Google Workspace/Microsoft 365 tenants.
region string

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

Deleted is true if tenant was terminated and can no longer be queried. Deleted tenant subscriptions has 'canceled' state.
Response example
{
  "id": "string",
  "external_id": "string",
  "kind": "string",
  "name": "string",
  "region": "string",
  "deleted": true
}