v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Get Tenant List

API to fetch a paginated list of tenants available in your workspace.

get/v1/tenant/

Query parameters

limitinteger

number of results to be returned in API response

offsetinteger

starting position of tenant list

Response

200 - OK

Example response

{
  "meta": {
    "count": 28,
    "limit": 20
  },
  "results": [
    {
      "tenant_id": "random_id",
      "tenant_name": "Awesome Tenant",
      "logo": "https://logo.png",
      "timezone": "America/New_York",
      "embedded_preference_url": "https://app.suprsend.com/en/user-settings/notifications",
      "hosted_preference_domain": "preferences.suprsend.com",
      "primary_color": "#ff0000",
      "secondary_color": "#ff0000",
      "tertiary_color": "#ff0000",
      "social_links": {
        "website": "https://suprsend.com"
      },
      "properties": {
        "address": "my company address"
      },
      "updated_at": "2025-04-06T20:57:16.935605Z"
    }
  ]
}