List custom-attribute definitions

Search Documentation

Search across all developer documentation

attributes

List custom-attribute definitions

GET /v1/attributes
Auth required api.attributes.view

Returns the org's custom-attribute registry, newest-first — the typed schema a Segment's SendQL predicate references as attr.<name>. This is the attribute definitions, not per-contact values (see /v1/contacts for values). No recipient PII. Registry management is dashboard-only; this API is read-only.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

Responses

200 Cursor-paginated list of attribute definitions application/json
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
422 Query parameter or path value failed validation 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