Allo

Rechercher des personnes

Cet endpoint est pagine. Utilisez page et size dans le corps de la requete pour controler les resultats. Voir Pagination.

POST/v2/api/crm/people/search

Cet endpoint est pagine. Utilisez page et size dans le corps de la requete pour controler les resultats. Voir Pagination.

Corps de la requete

ChampTypeDescription
filtersobjectFiltres nommes (voir ci-dessous)
searchstringRecherche en texte integral sur les champs de la personne
sortstringOrdre de tri : DATE_DESC, DATE_ASC, NAME_ASC, NAME_DESC, CREATED_DESC, CREATED_ASC
pageintegerNumero de page (commence a 1)
sizeintegerResultats par page (max 100)

Filtres

Passez un objet avec des champs nommes. Tous les filtres fournis sont combines avec AND.

{
  "filters": {
    "job_title": "engineer",
    "company": "Acme"
  },
  "sort": "NAME_ASC",
  "page": 1,
  "size": 20
}

Champs de filtre disponibles

ChampType de correspondanceDescription
namecontientPrenom
last_namecontientNom de famille
job_titlecontientTitre du poste
websitecontientURL du site web
companycontientNom de l'entreprise
phone_numberexactNumero de telephone
emailcontientAdresse e-mail
deal_statusexactStatut du deal

Attributs personnalisés

Chaque résultat 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, avec les mêmes formats que Obtenir une personne. Les attributs personnalisés ne peuvent servir ni de filtre ni de tri.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Corps

filtersobject | null

Named filters. All are combined with AND.

8 champs
namestring

Filter by first name (contains)

last_namestring

Filter by last name (contains)

job_titlestring

Filter by job title (contains)

websitestring

Filter by website (contains)

companystring

Filter by company name (contains)

phone_numberstring

Filter by phone number (exact match)

emailstring

Filter by email (contains)

deal_statusstring

Filter by deal status (exact match)

searchstring | null

Free-text search across name, email, phone number, and company

sortenum<string>

Sort order (default: DATE_DESC)

DATE_DESCDATE_ASCNAME_ASCNAME_DESCCREATED_DESCCREATED_ASC

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Réponses

200Search results
dataobject[]
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.

paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
401
422
429