Get Tenant Data

API to fetch tenant settings (logo, colors, links, preference) corresponding to a tenant_id. To create or update tenant data, use the Create/Update Tenant endpoint. To create or update tenant data, use the Create/Update Tenant endpoint. To create or update tenant data, use the Create/Update Tenant endpoint.

GET /v1/tenant/{tenant_id}

Get Tenant data

cURL

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

200

{
  "tenant_id": "_tenant_id_",
  "tenant_name": "Awesome Tenant",
  "logo": "https://ik.imagekit.io/l0quatz6utm/suprsend/staging/media/suprsend-only-logo_c8aa27faef118418e8c5bd7b31a1cafc74e09200.png",
  "timezone": null,
  "blocked_channels": [
    "email"
  ],
  "embedded_preference_url": "https://app.suprsend.com/en/user-settings/notifications",
  "hosted_preference_domain": "preferences.suprsend.com",
  "primary_color": "#ff0000",
  "secondary_color": "#0000ff",
  "tertiary_color": "#00ffff",
  "social_links": {
    "website": "https://suprsend.com",
    "facebook": "https://www.company.com",
    "linkedin": "",
    "x": "",
    "instagram": "",
    "medium": "",
    "discord": "",
    "telegram": "",
    "youtube": "",
    "tiktok": ""
  },
  "properties": {
    "k1": "v1",
    "address": "my company address"
  },
  "updated_at": "2025-04-06T21:01:35.359787Z"
}

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

200

application/json

200

Updated Object Payload is returned in response. JSON structure similar to request payload.