SUsuprsend

List Tenants

Changed on

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

get/v1/tenant/

Request

Query parameters

limitinteger

Number of tenants to return per page.

offsetinteger

Number of tenants to skip.

parent_idstring

Returns only direct children of the given tenant.

ancestor[]string[]

Returns all descendants (at any depth) of the given tenant. The tenant itself is not included. Repeat the param to pass multiple tenants.

level[]integer[]

Returns tenants at the given level(s). Root = 0, max = 4. Repeat the param to combine levels.

Response

200 - OK

Example response

{
  "meta": {
    "count": 28,
    "limit": 20
  },
  "results": [
    {
      "id": "acme-corp",
      "name": "Acme Corp",
      "tenant_id": "acme-corp",
      "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": {
        "region": "US"
      },
      "ancestors": [],
      "children_count": 2,
      "updated_at": "2026-08-27T20:57:16.935605Z"
    }
  ]
}

Changes

  • 5f0169085547Revision changes
    • breaking

      for the query request parameter limit, default value was changed from 20 to 10

  • ea7b2f7c41a9Revision changes
    • info

      added the new optional query request parameter ancestor[]

    • info

      added the new optional query request parameter level[]

    • info

      added the new optional query request parameter parent_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status