tags
List tags and folders
GET /v1/tags
Auth required
api.tags.view
Returns the org's tag vocabulary, ordered by full path. Tags are org-side
annotations shared across Lists, Segments and Templates and double as
Gmail-style folders (nest via / in the name). Tag lifecycle and
assignment are dashboard-only; this API is read-only. Cursors are opaque
base64; stale or malformed cursors silently fall back to page 1.
Query parameters
limit integer optional Page size (1–200). Default 50.
cursor string optional Opaque cursor returned from the previous page.
Responses
Errors follow the RFC 7807 problem format — see the error reference.
200 Cursor-paginated list of tags, by path application/json
data array<object> required Each entry in data:
id string<uuid> required name string required Full folder path (e.g. Marketing/Newsletters).
key string required Normalized slug handle of the name.
color string optional Chip colour token (chart-1..chart-5), or empty.
description string optional created_at string<date-time> required updated_at string<date-time> required pagination object required Fields of pagination:
has_more boolean required next_cursor string | null optional 401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
422 A query parameter, path value or body field failed validation.
The body is a
validation_failed Problem. When the refusal is about a
reference — a segment key, template slug, topic or attribute name the
organization does not have — it additionally carries validation_code,
field, line/column, missing, candidates and next_step, so a
client can correct the call without a second round of guessing. See
ValidationProblem.
application/problem+json 429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json