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 endpoint.

get/v1/tenant/{tenant_id}/

Path parameters

tenant_idstring required

unique identifier of the tenant you want to get the details for

Response

idstring

Tenant id. Replaces the legacy tenant_id field; both are returned.

namestring

Tenant display name. Replaces the legacy tenant_name field; both are returned.

tenant_idstring

Will be deprecated in future. Use id instead.

tenant_namestring

Will be deprecated in future. Use name instead.

parent_idstring nullable

Parent tenant id when this tenant is a sub-tenant. null for root tenants (including flat tenants that aren't part of a hierarchy).

ancestorsstring[]

For sub-tenants: ancestor tenant ids from root down to the immediate parent (excludes the tenant itself). Empty for root and flat tenants.

levelinteger

For sub-tenants: depth in the tree. Root = 0, max = 4. Flat tenants always report 0.

children_countinteger

For sub-tenants: number of direct children. 0 for tenants with no sub-tenants.

logostring uri nullable

Tenant logo URL.

timezonestring nullable

Tenant timezone. Used as a fallback when the recipient user has no timezone set.

blocked_channelsstring[] nullable

Channels turned off for this tenant. Notifications on these channels won't be sent to any user of the tenant — including on root categories (which users normally can't unsubscribe from) — and users can't override this. If sub-tenants are used, a block set here also applies to every sub-tenant below and can't be removed lower down.

embedded_preference_urlstring uri

URL of your product's preference page.

hosted_preference_domainstring

Domain of the SuprSend-hosted preference page.

primary_colorstring nullable

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.

secondary_colorstring nullable

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.

tertiary_colorstring nullable

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.

propertiesobject

Custom tenant properties (local values only). Inherited values from ancestors are resolved at trigger time.

updated_atstring date-time

Timestamp when the tenant was last updated.

Example response

{
  "id": "eu-sales",
  "name": "EU Sales",
  "tenant_id": "eu-sales",
  "tenant_name": "EU Sales",
  "parent_id": "eu",
  "ancestors": [
    "acme-corp",
    "eu"
  ],
  "level": 2,
  "logo": "https://logo.png",
  "timezone": "America/New_York",
  "blocked_channels": [
    "sms"
  ],
  "embedded_preference_url": "https://app.suprsend.com/en/user-settings/notifications",
  "hosted_preference_domain": "preferences.suprsend.com",
  "primary_color": "#ff0055",
  "secondary_color": "#00ff00",
  "tertiary_color": "#0000ff",
  "social_links": {
    "website": "https://suprsend.com"
  },
  "properties": {
    "team_size": 42
  },
  "updated_at": "2026-08-27T21:01:35.359787Z"
}

Changes

Changed in 1 of the 7 revisions of this API.19

Aug 30, 2026ea7b2f7c41a919See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history