namestring required
Human-readable name of the custom property. Unique within the team.
descriptionstring nullable
Optional description of what the property represents.
display_type'text' | 'link' | 'number' | 'currency' | 'percent' | 'date' | 'datetime' | 'boolean' | 'select' required
- text - text
- link - link
- number - number
- currency - currency
- percent - percent
- date - date
- datetime - datetime
- boolean - boolean
- select - select
target_type'account' | 'person' | 'group'
- account - account
- person - person
- group - group
group_type_indexinteger nullable
For 'group' targets only: which group type (0-4) the property attaches to. Required when target_type is 'group'; must be omitted otherwise. Create-only.
is_big_numberboolean
Abbreviate large numbers (e.g. 10,000 → 10K). Only applies to numeric properties.
is_canonicalboolean required
True when PostHog writes this property itself. Its name and display type are fixed — an update changing either is rejected.
created_atstring date-time required
created_byinteger nullable required
updated_atstring date-time nullable required
has_workflow_referenceboolean required
Whether a workflow updates this property. Always returned, even when workflow details are hidden.