List promoted activity-property definitions
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.
Built-in properties are not listed here. Every activity whose name starts
with site_ — the website-tracking activities — carries six built-in string
properties on every organization: path, referrer, title, utm_source,
utm_medium and utm_campaign. They are always evaluable in a predicate, have
no definition row and cannot be promoted or demoted, so they never appear in
this collection. An empty list therefore does not mean no activity property is
evaluable.
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.
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 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 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 code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json