> ## Documentation Index > Fetch the complete documentation index at: https://docs.suprsend.com/llms.txt > Use this file to discover all available pages before exploring further. # List Tenants > API to fetch a paginated list of tenants available in your workspace. ## OpenAPI ````yaml GET /v1/tenant/ openapi: 3.1.1 info: title: SuprSend API description: APIs supported on suprsend platform version: 1.2.2 servers: - url: https://hub.suprsend.com security: - sec0: [] - BearerAuth: [] paths: /v1/tenant/: get: summary: List Tenants description: API to fetch a paginated list of tenants available in your workspace. operationId: get-tenant-list parameters: - name: limit in: query description: Number of tenants to return per page. schema: type: integer default: 20 - name: offset in: query description: Number of tenants to skip. schema: type: integer - name: parent_id in: query description: Returns only direct children of the given tenant. required: false schema: type: string example: acme-corp - name: ancestor[] in: query description: Returns the given tenant and all its descendants at any depth. required: false schema: type: array items: type: string example: - acme-corp - name: level[] in: query description: >- Returns tenants at the given level(s). Root = 0, max = 4. Repeat the param to combine levels. required: false schema: type: array items: type: integer example: - 0 responses: '200': description: 200 - OK content: application/json: examples: Result: value: meta: count: 28 limit: 20 offset: 0 results: - id: acme-corp name: Acme Corp tenant_id: acme-corp tenant_name: Acme Corp parent_id: null ancestors: [] level: 0 children_count: 2 logo: >- https://ik.imagekit.io/l0quatz6utm/suprsend/staging/media/suprsend-only-logo_c8aa27faef118418e8c5bd7b31a1cafc74e09200.png timezone: null blocked_channels: null embedded_preference_url: >- https://app.suprsend.com/en/user-settings/notifications hosted_preference_domain: preferences.suprsend.com primary_color: '#ff0000' secondary_color: null tertiary_color: null social_links: website: https://suprsend.com facebook: '' linkedin: '' x: '' instagram: '' medium: '' discord: '' telegram: '' youtube: '' properties: {} updated_at: '2026-08-27T20:57:16.935605Z' schema: type: object properties: meta: type: object properties: count: type: integer example: 28 description: Total number of results returned. limit: type: integer example: 20 description: Maximum number of results per page. offset: type: integer example: 0 description: offset passed in request results: type: array description: >- List of tenants available in the workspace. Tenant JSON is the same shape as the [create/update tenant](/reference/create-update-tenants) response, including the `parent_id`, `ancestors`, `level`, and `children_count` fields introduced with [sub-tenants](/docs/sub-tenants). items: type: object properties: id: type: string description: >- Tenant `id`. Replaces the legacy `tenant_id` field; both are returned. example: acme-corp name: type: string description: >- Tenant display name. Replaces the legacy `tenant_name` field; both are returned. example: Acme Corp tenant_id: type: string description: Will be deprecated in future. Use `id` instead. example: acme-corp tenant_name: type: string description: Will be deprecated in future. Use `name` instead. example: Awesome Tenant logo: type: string format: uri description: Tenant logo URL. example: https://logo.png timezone: type: string nullable: true description: >- Tenant timezone. Used as a fallback when the recipient user has no timezone set. example: America/New_York blocked_channels: type: string nullable: true examples: email: summary: Email channel value: email sms: summary: SMS channel value: sms description: >- Channels turned off for this tenant. Notifications on these channels won't be sent to any user of the tenant — including on [root categories](/docs/notification-category#root-categories) (which users normally can't unsubscribe from) — and users can't override this. If [sub-tenants](/docs/sub-tenants) are used, a block set here also applies to every sub-tenant below and can't be removed lower down. embedded_preference_url: type: string format: uri description: URL of your product's preference page. example: >- https://app.suprsend.com/en/user-settings/notifications hosted_preference_domain: type: string description: Domain of the SuprSend-hosted preference page. example: preferences.suprsend.com primary_color: type: string description: >- Primary brand color, used in the tenant's email header, buttons, and footer. If left empty on create, it's copied from the default tenant. example: '#ff0000' secondary_color: type: string nullable: true description: >- Secondary brand color. Not part of the default tenant component but can be used in templates as `{{$tenant.secondary_color}}`. If left empty on create, it's copied from the default tenant. example: '#ff0000' tertiary_color: type: string nullable: true description: >- Tertiary brand color. Not part of the default tenant component but can be used in templates as `{{$tenant.tertiary_color}}`. If left empty on create, it's copied from the default tenant. example: '#ff0000' social_links: type: object description: Tenant's social media URLs. properties: website: type: string example: https://suprsend.com facebook: type: string example: '' linkedin: type: string example: '' x: type: string example: '' instagram: type: string example: '' medium: type: string example: '' discord: type: string example: '' telegram: type: string example: '' youtube: type: string example: '' properties: type: object description: >- Custom tenant properties (local values only). Inherited values from ancestors are resolved at trigger time. additionalProperties: true example: region: US parent_id: type: string nullable: true description: >- Parent tenant `id` when this tenant is a [sub-tenant](/docs/sub-tenants). `null` for root tenants (including flat tenants that aren't part of a hierarchy). example: null ancestors: type: array items: type: string description: >- For [sub-tenants](/docs/sub-tenants): ancestor tenant `id`s from root down to the immediate parent (excludes the tenant itself). Empty for root and flat tenants. example: [] level: type: integer description: >- For [sub-tenants](/docs/sub-tenants): depth in the tree. Root = 0, max = 4. Flat tenants always report `0`. example: 0 children_count: type: integer description: >- For [sub-tenants](/docs/sub-tenants): number of direct children. `0` for tenants with no sub-tenants. example: 2 updated_at: type: string format: date-time description: Timestamp when the tenant was last updated. example: '2026-08-27T20:57:16.935605Z' deprecated: false security: - BearerAuth: [] components: securitySchemes: sec0: type: apiKey in: header name: Authorization x-bearer-format: bearer description: >- Bearer authentication header of the form `Bearer `, where is your auth token. BearerAuth: type: http scheme: bearer bearerFormat: API_Key description: >- Pass as `Bearer `. Get API Key from SuprSend dashboard Developers -> API Keys section. ````