Tenants - Retrieve
  • 22 Dec 2023
  • 1 Minute to read
  • Dark
    Light

Tenants - Retrieve

  • Dark
    Light

Article summary

The Retrieve Tenant endpoint returns the requested tenant data object. The authenticated user must be a member of the Tenant to retrieve the tenant meta-data.

To retrieve a tenant's meta-data, pass the following fields with the request body:

Argument
Description

tenant_id
string

(required) The unique identifier of the Tenant object to be retrieved

'Current' Tenant

Specify /1/tenants/current to retrieve the currently-authorized tenant

Example: Retrieve a Tenant

curl -X GET https://api.cogniac.io/1/tenants/current \
-H "Authorization: Bearer abcdefg.hijklmnop.qrstuvwxyz"
import requests

my_headers = {"Authorization":"Bearer abcdefg.hijklmnop.qrstuvwxyz"}
resp = requests.get("https://api.cogniac.io/1/tenants/current",
                    headers=my_headers)
print(resp.content)
{
  "tenant_id":"63QhzFLc9tg4",
  "name":"Cogniac Demo Updated",
  "description":"Updated Description",
  "created_at":1455044755,
  "modified_at":1455044770,
  "created_by":"test@cogniac.co"
}

Was this article helpful?