List promoted activity-property definitions

Search Documentation

Search across all developer documentation

activity-properties

List promoted activity-property definitions

GET /v1/activity-properties
Auth required api.activities.view

Returns the org's promoted activity-property registry, newest-first — the typed schema a Segment's SendQL predicate references as activity.<activity>.<property>. A custom-activity property is inert, non-evaluable JSON until it is promoted; this endpoint lists the definitions, not the per-contact values. No recipient PII.

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 activity-property 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