Get Tenant

GET

tenant

{tenant_id}

Get Tenant

curl --request GET \
  --url https://hub.suprsend.com/v1/tenant/{tenant_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://hub.suprsend.com/v1/tenant/{tenant_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://hub.suprsend.com/v1/tenant/{tenant_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://hub.suprsend.com/v1/tenant/{tenant_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://hub.suprsend.com/v1/tenant/{tenant_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "No tenant found for tenant_id tenant",
  "detail": "No tenant found for tenant_id tenant"
}

Authorizations

Authorization

string

header

required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

tenant_id

string

required

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

Response

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), unset fields stay unresolved and the tenant simply has no value for them. For sub-tenants, unset fields still return null here, but are resolved from the closest ancestor that has a value set at trigger time.

string

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

Example:

"eu-sales"

name

string

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

Example:

"EU Sales"

tenant_id

string

Will be deprecated in future. Use id instead.

Example:

"eu-sales"

tenant_name

string

Will be deprecated in future. Use name instead.

Example:

"EU Sales"

parent_id

string | null

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

Example:

"eu"

ancestors

string[]

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

Example:

["acme-corp", "eu"]

level

integer

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

Example:

2

children_count

integer

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

Example:

0

logo

string<uri> | null

Tenant logo URL.

Example:

"https://logo.png"

timezone

string | null

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

Example:

"America/New_York"

blocked_channels

string[] | null

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.

Example:

["sms"]

embedded_preference_url

string<uri>

URL of your product's preference page.

Example:

"https://app.suprsend.com/en/user-settings/notifications"

hosted_preference_domain

string

Domain of the SuprSend-hosted preference page.

Example:

"preferences.suprsend.com"

primary_color

string | null

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

string | null

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

string | null

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"

Tenant's social media URLs.

Show child attributes

properties

object

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

Example:

{ "team_size": 42 }

updated_at

string<date-time>

Timestamp when the tenant was last updated.

Example:

"2026-08-27T21:01:35.359787Z"

⌘I

Get Tenant

curl --request GET \
  --url https://hub.suprsend.com/v1/tenant/{tenant_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://hub.suprsend.com/v1/tenant/{tenant_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://hub.suprsend.com/v1/tenant/{tenant_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://hub.suprsend.com/v1/tenant/{tenant_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://hub.suprsend.com/v1/tenant/{tenant_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "No tenant found for tenant_id tenant",
  "detail": "No tenant found for tenant_id tenant"
}

API Reference

USERS

TRIGGER WORKFLOWS

EVENTS

MESSAGES

OBJECTS

TEMPLATES

TENANTS

PREFERENCE

LISTS

BROADCAST

Authorizations

Path Parameters

Response