Get one activity-property definition

Search Documentation

Search across all developer documentation

activity-properties

Get one activity-property definition

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

Returns one promoted activity-property definition by its dotted activity.property handle or its id, or 404 not_found when the handle names no activity property in this org.

Path parameters

id string required

The property's UUID or the dotted activity.property form (for example order.total) — the same spelling a SendQL predicate uses, minus its leading activity. prefix. Split on the LAST dot, since an activity name may contain one and a property name may not. Unknown handles read as 404 not_found.

Responses

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

200 The activity-property definition application/json
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
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found 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