---
title: "Get a tenant"
method: GET
path: "/v1/tenants/{id}"
tags: ["Tenants"]
---

# Get a tenant

`GET /v1/tenants/{id}`

Get a tenant by ID.

## Path parameters

- `id` string, required

## Query parameters

- `resolve_full_preference_settings` boolean

## Response `200`

OK

- Tenant — A tenant entity.
  - `__typename` string, required — The typename of the schema.
  - `id` string, required — The unique identifier for the tenant.
  - `name` string, nullable — An optional name for the tenant.
  - `settings` object, nullable — The settings for the tenant. Includes branding and preference set.
    - `branding` object, nullable — The branding for the tenant.
      - `icon_url` string, uri, nullable — The icon URL for the tenant. Must point to a valid image with an image MIME type.
      - `logo_url` string, uri, nullable — The logo URL for the tenant. Must point to a valid image with an image MIME type.
      - `primary_color` string, nullable — The primary color for the tenant, provided as a hex value.
      - `primary_color_contrast` string, nullable — The primary color contrast for the tenant, provided as a hex value.
    - `preference_set` union — The preference set for the tenant. Used to override the default preference set.
      - object — A preference set represents a specific set of notification preferences for a recipient. A recipient can have multiple preference sets.
        - `categories` union — An object where the key is the category and the values are the preference settings for that category.
          - object — An object where the key is the category and the values are the preference settings for that category.
          - unknown
        - `channel_types` union — An object where the key is the channel type and the values are the preference settings for that channel type.
          - object — Channel type preferences.
            - `chat` union — Whether the channel type is enabled for the preference set.
              - …
            - `email` union — Whether the channel type is enabled for the preference set.
              - …
            - `http` union — Whether the channel type is enabled for the preference set.
              - …
            - `in_app_feed` union — Whether the channel type is enabled for the preference set.
              - …
            - `push` union — Whether the channel type is enabled for the preference set.
              - …
            - `sms` union — Whether the channel type is enabled for the preference set.
              - …
          - unknown
        - `channels` union — An object where the key is the channel ID and the values are the preference settings for that channel ID.
          - object — Channel preferences.
          - unknown
        - `commercial_subscribed` boolean, nullable — Whether the recipient is subscribed to commercial communications. When false, the recipient will not receive commercial workflow notifications.
        - `id` string, required — Unique identifier for the preference set.
        - `workflows` union — An object where the key is the workflow key and the values are the preference settings for that workflow.
          - object — An object where the key is the workflow key and the values are the preference settings for that workflow.
          - unknown
      - unknown

---

[API](https://skmtc.net/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.net/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knocklabs/knock-api/revisions/4b8499dddbc5/schema)