---
title: "Get Tenant List"
method: GET
path: "/v1/tenant/"
---

# Get Tenant List

`GET /v1/tenant/`

API to fetch a paginated list of tenants available in your workspace.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

200 - OK

- object
  - `meta` object
    - `count` integer — Total number of results returned.
    - `limit` integer — Maximum number of results per page.
    - `offset` integer — offset passed in request
  - `results` object[] — List of tenants available in the workspace. Tenant JSON is same as tenant upsert response.
    - `tenant_id` string — Unique identifier of the tenant.
    - `tenant_name` string — Name of the tenant.
    - `logo` string, uri — URL of the tenant logo.
    - `timezone` string, nullable — timezone of the tenant. Used as fallback if user's timezone is not set.
    - `blocked_channels` string, nullable — channels that are blocked for the tenant.
    - `embedded_preference_url` string, uri — url of the preference page inside the tenant product.
    - `hosted_preference_domain` string — domain of the hosted preference page.
    - `primary_color` string — Primary color of the tenant used for template design.
    - `secondary_color` string, nullable — Secondary color of the tenant.
    - `tertiary_color` string, nullable — Tertiary color of the tenant.
    - `social_links` object — Social media links associated with the tenant.
      - `website` string
      - `facebook` string
      - `linkedin` string
      - `x` string
      - `instagram` string
      - `medium` string
      - `discord` string
      - `telegram` string
      - `youtube` string
    - `properties` object — Custom properties associated with the tenant.
    - `updated_at` string, date-time — Timestamp when the tenant was last updated.

---

[API](https://skmtc.net/suprsend/apis/suprsend-api.md) · [All operations](https://skmtc.net/suprsend/apis/suprsend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/suprsend/suprsend-api/versions/8bd2574bd2c3/schema)