Get Tenant by ID

Retrieve information about a tenant. The attributes object will contain flags indicating whether or not certain features are enabled on the tenant. Kibo employees can reference <a href="/pages/tenant-attributes">this internal-only documentation</a> for a list of all attributes. </ul>

GET /platform/tenants/{tenantId}

Error

A valid request URL is required to generate request examples

200

{
  "attributes": [
    {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z",
      "value": null
    }
  ],
  "domain": "<string>",
  "expiry": "2023-11-07T05:31:56Z",
  "id": 123,
  "isDevTenant": true,
  "isUnified": true,
  "lastLoginDate": "2023-11-07T05:31:56Z",
  "masterCatalogs": [
    {
      "catalogs": [
        {
          "defaultCurrencyCode": "<string>",
          "defaultLocaleCode": "<string>",
          "id": 123,
          "masterCatalogId": 123,
          "name": "<string>",
          "tenantId": 123
        }
      ],
      "defaultCurrencyCode": "<string>",
      "defaultLocaleCode": "<string>",
      "id": 123,
      "name": "<string>",
      "supportedLocaleCodes": [
        "<string>"
      ],
      "tenantId": 123
    }
  ],
  "name": "<string>",
  "sites": [
    {
      "attributes": [
        {
          "createBy": "<string>",
          "createDate": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "updateBy": "<string>",
          "updateDate": "2023-11-07T05:31:56Z",
          "value": null
        }
      ],
      "catalogId": 123,
      "countryCode": "<string>",
      "currencyCode": "<string>",
      "domain": "<string>",
      "id": 123,
      "localeCode": "<string>",
      "name": "<string>",
      "primaryCustomDomain": "<string>",
      "tenantId": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

tenantId · integer<int32> · required

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

attributes · object[] | null

Show child attributes

domain · string | null

expiry · string<date-time> | null

id · integer<int32>

isDevTenant · boolean

isUnified · boolean

lastLoginDate · string<date-time> | null

masterCatalogs · object[] | null

Show child attributes

name · string | null

sites · object[] | null

Show child attributes