List contact properties
GET
/v1/contact-properties
curl -X GET "https://us1.platform.bird.com/v1/contact-properties" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"Returns a paginated list of the workspace's contact properties.
Paramètres de requête
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Contenu de la réponse
data
array of object
obligatoire
Page of contact property objects.
Afficher les attributs enfants
data.id
string
obligatoire
Contact property ID.
data.key
string
obligatoire
The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
data.type
string
obligatoire
The value type every contact must use for this property. Cannot be changed after creation.
data.fallback_value
Default used when a contact has no value for this property and the template does not supply an inline fallback. A string, number, or boolean matching the declared type (strings up to 500 characters), or null when no fallback is set.
data.archived
boolean
Whether the property is archived. An archived property is rejected in new contact writes and stops rendering in templates, but every value already stored on contacts is preserved. Reactivate it with unarchive.
data.created_at
string
obligatoire
data.updated_at
string
obligatoire
next_cursor
nullable string
obligatoire
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obligatoire
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obligatoire
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.