Get a contact property

GET

/v1/contact-properties/{property_id}

const prop = await bird.contactProperties.get("cp_01krdgeqcxet5s7t44vh8rt9mg");
console.log(prop.key, prop.type);

prop = client.contact_properties.get("prp_01krdgeqcxet5s7t44vh8rt9mg")
print(prop.key, prop.type)

property, err := client.ContactProperties.Get(context.Background(), "prp_123")
if err != nil {
	log.Fatal(err)
}
fmt.Println(property.Key)

$property = $bird->contactProperties->get('cp_01krdgeqcxet5s7t44vh8rt9mg');
echo $property->getKey(), ' ', $property->getType();

bird contact-properties get <property-id>

curl -X GET "https://us1.platform.bird.com/v1/contact-properties/{property_id}" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

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

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

Paramètres

property_id

string

ID of the contact property to fetch.

Contenu de la réponse

string

obligatoire

ID of the property, accepted by every operation that takes a property_id.

key

string

obligatoire

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

obligatoire

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.

Possible values: string, number, boolean, datetime

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, boolean, or RFC 3339 datetime matching the declared type (strings up to 500 characters), or null when no fallback is set.

archived

boolean

Whether the property is archived. Archived keys are rejected in new contact writes and when publishing a new template version. Stored contact values are preserved, and previously published versions keep rendering them. Unarchive the property to use its key in new writes and template versions.

created_at

string

obligatoire

updated_at

string

obligatoire

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.

Regarder le guideManage your customers: contacts & audiences Explorer la fonctionnalitéContacts and audiences Suivre le parcours d'apprentissageBuild your first integration Guide d'implémentationAudiences

Obtenir un guide d'implémentation

const prop = await bird.contactProperties.get("cp_01krdgeqcxet5s7t44vh8rt9mg");
console.log(prop.key, prop.type);

prop = client.contact_properties.get("prp_01krdgeqcxet5s7t44vh8rt9mg")
print(prop.key, prop.type)

property, err := client.ContactProperties.Get(context.Background(), "prp_123")
if err != nil {
	log.Fatal(err)
}
fmt.Println(property.Key)

$property = $bird->contactProperties->get('cp_01krdgeqcxet5s7t44vh8rt9mg');
echo $property->getKey(), ' ', $property->getType();

bird contact-properties get <property-id>

curl -X GET "https://us1.platform.bird.com/v1/contact-properties/{property_id}" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

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