Return every category registered for your partner, so you can look up the integer ID to use in the category field of a send.
Endpoint and headers
Header | Value | Purpose |
|---|---|---|
X-INS-AUTH-KEY | API token, format INS.{id}.{secret} | Authentication |
This request has no body.
Sample response
Below is a sample response for this request.
{
"categories": [
{
"id": 3,
"name": "order_confirmation",
"description": "Post-purchase confirmations",
"created_at": "2026-06-29T10:00:00Z"
},
{
"id": 7,
"name": "password_reset",
"description": "Account security emails",
"created_at": "2026-06-29T10:05:00Z"
}
]
}Keep in mind
Results are ordered by ID in ascending order, with no pagination.
A customer with no categories returns { "categories": [] }.
To create a category, refer to POST /mail/v2/categories. For error codes, refer to the Error Codes.