Skip to main content
GET
/
v1
/
tenant
/
{tenant_id}
/
preference
/
category
Get Tenant Preference All Categories
curl --request GET \
  --url https://hub.suprsend.com/v1/tenant/{tenant_id}/preference/category/ \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "count": 29,
    "limit": 10,
    "offset": 0
  },
  "results": [
    {
      "name": "sreehari_test",
      "category": "sreehari_test",
      "description": null,
      "tags": null,
      "effective_tags": [
        "wwr"
      ],
      "root_category": "system",
      "default_preference": "cant_unsubscribe",
      "default_mandatory_channels": [
        "email"
      ],
      "default_opt_in_channels": [
        "slack"
      ],
      "enabled_for_tenant": true,
      "visible_to_subscriber": true,
      "preference": null,
      "mandatory_channels": null,
      "opt_in_channels": null,
      "blocked_channels": null,
      "updated_at": null
    }
  ]
}

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 preferences for

Query Parameters

​
locale
string

Locale code (e.g., es, fr, de, ja, es-AR) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file. If a translation is missing for the requested locale, the system automatically falls back in this order: locale-region (e.g., es-AR) → locale (e.g., es) → en (English - always available).

​
limit
integer
default:10

Number of results to return per page

​
offset
integer
default:0

Number of results to skip

Response

200

​
meta
object
​
results
object[]