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

Errors follow the RFC 7807 problem format — see the error reference.

200 Cursor-paginated list of activity-property definitions application/json
data array<object> required

Each entry in data:

id string<uuid> required
activity_name string required

The custom activity whose property this promotes; a lowercase identifier.

property_name string required

The property key inside the activity's properties; a lowercase identifier.

type string enum required

One of: string, number, bool, datetime, enum

enum_values array<string> optional

Allowed values when type is enum; omitted otherwise.

description string required
origin string enum optional

Where the property is authored: managed (via the API/dashboard) or git (synced from a connected repo and read-only via the API).

One of: managed, git

source_path string optional

Repo-relative source file, for git-backed properties only.

last_synced_at string<date-time> optional

Time of the last git sync, for git-backed properties only.

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