Allo

Rechercher des entreprises

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

POST/v2/api/crm/companies/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)
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": {
    "name": "Acme",
    "industry": "Technology"
  },
  "sort": "NAME_ASC",
  "page": 1,
  "size": 20
}

Champs de filtre disponibles

ChampType de correspondanceDescription
namecontientNom de l'entreprise
websitecontientURL du site web
industrycontientSecteur d'activite

Attributs personnalisés

Chaque résultat inclut custom_attributes, les valeurs de vos attributs d'entreprise indexées par clé d'attribut. Toujours présent, {} s'il n'y en a aucune, avec les mêmes formats que Obtenir une entreprise. 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.

3 champs
namestring

Filter by company name (contains)

websitestring

Filter by website (contains)

industrystring

Filter by industry (contains)

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[]
11 champs
idstring

Unique company identifier

namestring

Company name

websitestring | null

Company website URL

industrystring | null

Industry sector

numbersstring[]

Phone numbers of the company, in E.164 format

person_countinteger

Number of people linked to this company

interactionsinteger

Total number of interactions across all people in this company

last_activity_atstring<date-time> | null

Timestamp of the last activity

created_atstring<date-time>

When the company was created

updated_atstring<date-time>

When the company was last updated

custom_attributesobject

Values of the company'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/companies/attributes.

paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
401
422
429