---
title: "Get a List of Tenants"
method: GET
path: "/tenants"
tags: ["Tenants"]
---

# Get a List of Tenants

`GET /tenants`

Lists the workspace's tenants, each carrying a name, parent tenant, properties, and default preferences. Paged.

## Query parameters

- `parent_tenant_id` string, nullable
- `limit` integer, nullable
- `cursor` string, nullable

## Response `200`

- TenantListResponse
  - `cursor` string, nullable — A pointer to the next page of results. Defined only when has_more is set to true.
  - `has_more` boolean, required — Set to true when there are more pages that can be retrieved.
  - `items` Tenant[], required — An array of Tenants
    - `id` string, required — Id of the tenant.
    - `name` string, required — Name of the tenant.
    - `parent_tenant_id` string, nullable — Tenant's parent id (if any).
    - `default_preferences` DefaultPreferences
      - `items` SubscriptionTopic[], nullable
        - `status` 'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED', required
        - `has_custom_routing` boolean, nullable — Override channel routing with custom preferences. This will override any template preferences that are set, but a user can still customize their preferences
        - `custom_routing` ChannelClassification[], nullable — The default channels to send to this tenant when has_custom_routing is enabled
    - `properties` object, nullable — Arbitrary properties accessible to a template.
    - `user_profile` object, nullable — A user profile object merged with user profile on send.
    - `brand_id` string, nullable — Brand to be used for the account when one is not specified by the send call.
  - `next_url` string, nullable — A url that may be used to generate fetch the next set of results. Defined only when has_more is set to true
  - `url` string, required — A url that may be used to generate these results.
  - `type` 'list', required — Always set to "list". Represents the type of this object.

---

[API](https://skmtc.net/trycourier/apis/courier.md) · [All operations](https://skmtc.net/trycourier/apis/courier/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trycourier/courier/versions/04f69fbf96a5/schema)