Skip to main content
GET
Get Category

Authorizations

ServiceToken <token>
string
header
required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace
string
required

Workspace slug (staging, production, etc.)

Query Parameters

mode
enum<string>
required

Mode to retrieve categories. Use 'live' for active categories or 'draft' for current draft.

Available options:
live,
draft

Response

Successfully retrieved preference category

$schema
string

JSON schema reference for preference category structure

Example:

"https://schema.suprsend.com/preference_category/v1/schema.json"

root_categories
object[]

Array of root preference categories

version_no
integer

Version number field as an identifier to track the version

Example:

1

status
enum<string>

Current status of the preference category

Available options:
draft,
active
validation_result
object

Result of validating the preference category