Get Tenant Default Preference

Changed on Oct 16, 2026

API to get default tenant preference for all categories.

get/v1/tenant/{tenant_id}/category/

Request

Base URL
https://hub.suprsend.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/suprsend/apis/suprsend-api/docs/v1/tenant/:tenant_id/category/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenant_idstring required

unique identifier of the tenant you want to get default preferences for

Query parameters

localestring

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).

Response

200

Example response

{
  "meta": {
    "count": 12,
    "limit": 10
  },
  "results": [
    {
      "root_category": "transactional"
    }
  ]
}

Changes

Oct 16, 20265f0169085547 Revision changes
- warning
  added the new cant_unsubscribe enum value to the // response property for the response status
Jul 13, 2026e54dd32705e8 Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from 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
- 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
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history