email-contacts

Get a contact property

Returns a single contact property: its immutable key and type, the fallback value, and whether it is archived.

get/v1/contact-properties/{property_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/contact-properties/{property_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

property_idstring required
Example:prp_01krdgeqcxet5s7t44vh8rt9mg

ID of the contact property to fetch.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The contact property.

idstring required
keystring required

The property key, used as the key in contact data and as the attribute in the bird.contact.<key> broadcast template variable. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.

type'string' | 'number' | 'boolean' | 'datetime' required

The value type every contact must use for a property. Cannot be changed after creation.

datetime values are RFC 3339 timestamps with an explicit offset. Examples include 2024-01-15T09:30:00Z and 2024-01-15T11:30:00+02:00. A bare date or a time with no offset is rejected. The value is normalized to UTC with second precision on write, so 2024-01-15T11:30:00+02:00 is stored and returned as 2024-01-15T09:30:00Z, and any fractional seconds are dropped.

fallback_valueunknown
archivedboolean

Whether the property is archived. Archived properties disappear from pickers and cannot be used in new template versions. Published templates keep sending. Stored values remain available to read and update. Unarchive the property to restore it.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "prp_01krdgeqcxet5s7t44vh8rt9mg",
  "key": "plan",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.