GET
/
v1
/
tenant
curl --request GET \
  --url https://hub.suprsend.com/v1/tenant/ \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "count": 28,
    "limit": 20,
    "offset": 0
  },
  "results": [
    {
      "tenant_id": "random_id",
      "tenant_name": "Awesome Tenant",
      "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": "",
        "twitter": "",
        "instagram": "",
        "medium": "",
        "discord": "",
        "telegram": "",
        "youtube": ""
      },
      "properties": {},
      "updated_at": "2025-04-06T20:57:16.935605Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20

number of results to be returned in API response

​
offset
integer

starting position of tenant list

Response

200 - application/json
200 - OK
​
meta
object
​
results
any[]

List of tenants available in the workspace. Tenant JSON is same as tenant upsert response.

Was this page helpful?