Allo

Lister les attributs d'entreprise

Renvoie les attributs personnalisés définis sur les entreprises de votre équipe, qu'ils aient été créés par vous ou synchronisés depuis vos intégrations CRM…

GET/v2/api/crm/companies/attributes

Renvoie les attributs personnalisés définis sur les entreprises de votre équipe, qu'ils aient été créés par vous ou synchronisés depuis vos intégrations CRM. Les attributs archivés ne sont pas listés.

Paramètres de requête

ParamètreTypeDéfautDescription
pageinteger1Numéro de page, à partir de 1
sizeinteger20Éléments par page, de 1 à 100

Champs de la réponse

ChampTypeDescription
keystringClé unique de l'attribut
labelstring ou nullNom affiché
typestring ou nullTEXT, NUMBER, DATE, BOOLEAN ou DROPDOWN
optionsarray ou nullObjets { key, label }. Uniquement pour DROPDOWN
is_visiblebooleanIndique si l'attribut est affiché dans les apps Allo
promptstring ou nullConsigne utilisée par l'AI CRM Manager pour remplir l'attribut à partir des appels
should_prompt_overrideboolean ou nullIndique si l'IA peut écraser une valeur existante
sourcestringallo, ou l'intégration qui gère l'attribut, comme hubspot
created_atstringDate-heure ISO 8601
updated_atstringDate-heure ISO 8601
{
  "data": [
    {
      "key": "employees",
      "label": "Employees",
      "type": "NUMBER",
      "options": null,
      "is_visible": true,
      "prompt": null,
      "should_prompt_override": null,
      "source": "hubspot",
      "created_at": "2026-10-07T14:21:08",
      "updated_at": "2026-10-07T14:21:08"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 20,
    "total_count": 1,
    "total_pages": 1,
    "has_more": false
  }
}

Erreurs

StatutCodeQuand
400INVALID_PAGE_SIZEpage est inférieur à 1, ou size n'est pas compris entre 1 et 100
403API_KEY_INSUFFICIENT_SCOPELa clé n'a pas le scope CRM_READ
404TEAM_NOT_FOUNDLe workspace n'utilise pas le nouveau modèle de contacts

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de requête

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Réponses

200List of company attributes
dataobject[]
10 champs
keystring

Unique key within your team

labelstring | null

Display name

typeenum<string>

TEXTNUMBERDATEBOOLEANDROPDOWN

optionsobject[]

Allowed values. Only set for DROPDOWN attributes.

2 champs
keystring
labelstring
is_visibleboolean

Whether the attribute is shown in the Allo apps

promptstring | null

Instruction the AI CRM Manager follows to fill this attribute from calls. A blank value clears it.

should_prompt_overrideboolean | null

Whether the AI may overwrite a value that is already set

sourcestring

allo for attributes created in Allo or with the API, otherwise the lowercase name of the integration that manages it, such as hubspot

created_atstring<date-time>
updated_atstring<date-time>
paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
400
401
403
404
429