Allo

Obtenir une personne

La réponse inclut custom attributes , les valeurs de vos champs personnalisés indexées par clé de champ. Toujours présent, s'il n'y en a aucune. Les champs…

GET/v2/api/crm/people/{id}

Attributs personnalisés

La réponse inclut custom_attributes, les valeurs de vos champs personnalisés indexées par clé de champ. Toujours présent, {} s'il n'y en a aucune. Les champs archivés et les champs sans valeur sont omis. Les valeurs NUMBER sont des décimaux (180 est renvoyé sous la forme 180.0), les valeurs DATE sont au format YYYY-MM-DD et les valeurs DROPDOWN sont la clé de l'option. Pour les définir, voir Créer une personne et Mettre à jour une personne.

{
  "data": {
    "id": "per-abc123",
    "name": "John",
    "custom_attributes": {
      "lead_source": "Webinar",
      "budget": 5000.0
    }
  }
}

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

Person ID (e.g., "per-abc123")

Réponses

200Person details
dataobject

A person in the CRM

14 champs
idstring

Unique person identifier

namestring | null

First name

last_namestring | null

Last name

job_titlestring | null

Job title

websitestring | null

Website URL

addressstring | null

Postal address

numbersstring[]

Phone numbers in E.164 format

emailsstring[]

Email addresses

companyobject | null

Embedded company reference

2 champs
idstring

Company ID

namestring

Company name

interactionsinteger

Total number of interactions (calls + messages)

last_activity_atstring<date-time> | null

Timestamp of the last activity

created_atstring<date-time>

When the person was created

updated_atstring<date-time>

When the person was last updated

custom_attributesobject

Values of the person's custom attributes, keyed by attribute key. Always present, {} when there are none. Archived attributes and empty values are omitted. NUMBER values are decimals (180 is returned as 180.0), DATE values are YYYY-MM-DD and DROPDOWN values are the option key. Create the attributes first with POST /v2/api/crm/attributes.

401
404
429