Skip to main content
GET
/
v1
/
{workspace}
/
preference_category
/
Get Category
curl -X GET "https://management-api.suprsend.com/v1/{workspace}/preference_category/" \
  --header "Authorization: ServiceToken {token}" \
  --header "Content-Type: application/json"
{
  "$schema": "https://schema.suprsend.com/preference_category/v1/schema.json",
  "categories": [
    {
      "root_category": "system",
      "sections": []
    },
    {
      "root_category": "transactional",
      "sections": [
        {
          "name": "Task Updates",
          "subcategories": [
            {
              "category": "tagged-to-me",
              "name": "Tagged to Me",
              "description": "Status Update or mentions on tasks assigned by me or tagged to me",
              "default_preference": "opt_in"
            }
          ]
        }
      ]
    },
    {
      "root_category": "promotional",
      "sections": [
        {
          "name": "Product Updates",
          "subcategories": [
            {
              "category": "newsletter",
              "name": "Newsletter",
              "default_preference": "opt_out"
            }
          ]
        }
      ]
    }
  ],
  "version_no": 15,
  "status": "draft",
  "validation_result": {
    "is_valid": false,
    "errors": [
      "it seems some subcategories have been deleted in this version, on which active workflows are configured. missing subcategories: [\"chapter-added\" \"forecast\" \"onboarding-guide\" \"training-new\"]"
    ]
  }
}

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"

​
categories
object[]

Array of 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

⌘I