> ## 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. # Get Tenant > API to fetch properties and blocked channel settingcorresponding to a tenant_id. To create or update tenant data, use the [Create/Update Tenant](#operation/create-tenants) endpoint. ## OpenAPI ````yaml GET /v1/tenant/{tenant_id}/ 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/{tenant_id}/: get: summary: Get Tenant description: >- API to fetch properties and blocked channel settingcorresponding to a tenant_id. To create or update tenant data, use the [Create/Update Tenant](#operation/create-tenants) endpoint. operationId: get-tenant parameters: - name: tenant_id in: path description: unique identifier of the tenant you want to get the details for schema: type: string required: true responses: '200': description: OK content: application/json: examples: Result: value: id: eu-sales name: EU Sales tenant_id: eu-sales tenant_name: EU Sales parent_id: eu ancestors: - acme-corp - eu level: 2 children_count: 0 logo: null timezone: null blocked_channels: null embedded_preference_url: https://app.suprsend.com/en/user-settings/notifications hosted_preference_domain: preferences.suprsend.com primary_color: '#ff0055' secondary_color: null tertiary_color: null social_links: website: https://sales.example.eu properties: team_size: 42 updated_at: '2026-08-27T21:01:35.359787Z' schema: type: object description: >- Tenant object returned. Fields hold the tenant's own local values — values not set on this tenant come back as `null` (or as empty objects/arrays). For flat tenants (no [sub-tenants](/docs/sub-tenants)), unset fields stay unresolved and the tenant simply has no value for them. For [sub-tenants](/docs/sub-tenants), unset fields still return `null` here, but are resolved from the closest ancestor that has a value set at trigger time. properties: id: type: string description: >- Tenant `id`. Replaces the legacy `tenant_id` field; both are returned. example: eu-sales name: type: string description: >- Tenant display name. Replaces the legacy `tenant_name` field; both are returned. example: EU Sales tenant_id: type: string description: Will be deprecated in future. Use `id` instead. example: eu-sales tenant_name: type: string description: Will be deprecated in future. Use `name` instead. example: EU Sales 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: eu 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: - acme-corp - eu level: type: integer description: >- For [sub-tenants](/docs/sub-tenants): depth in the tree. Root = 0, max = 4. Flat tenants always report `0`. example: 2 children_count: type: integer description: >- For [sub-tenants](/docs/sub-tenants): number of direct children. `0` for tenants with no sub-tenants. example: 0 logo: type: string format: uri nullable: true 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: array items: type: string nullable: true 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. example: - sms 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 nullable: true 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: '#ff0055' 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: '#00ff00' 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: '#0000ff' 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: '' tiktok: 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: team_size: 42 updated_at: type: string format: date-time description: Timestamp when the tenant was last updated. example: '2026-08-27T21:01:35.359787Z' '404': description: 404 - Not Found content: application/json: examples: Result: value: code: 404 error_code: not_found type: NotFound message: No tenant found for tenant_id tenant detail: No tenant found for tenant_id tenant schema: type: object description: error code and message detailing the error 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. ````