Allo

Lister les champs personnalisés

Renvoie les champs personnalisés définis sur les personnes de votre équipe, du plus ancien au plus récent. La liste inclut les champs créés via l'API et ceux…

GET/v2/api/crm/attributes

Renvoie les champs personnalisés définis sur les personnes de votre équipe, du plus ancien au plus récent. La liste inclut les champs créés via l'API et ceux synchronisés depuis vos intégrations CRM. Les champs supprimés (archivés) et les champs natifs comme name ou company n'y figurent pas.

Paramètres de requête

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

Voir Pagination.

Champs de la réponse

ChampTypeDescription
keystringClé unique du champ
labelstring ou nullNom affiché
typestring ou nullTEXT, NUMBER, DATE, BOOLEAN ou DROPDOWN
optionsarrayObjets { key, label }. Uniquement présent pour DROPDOWN
sourcestringallo, ou l'intégration qui gère le champ, comme hubspot
{
  "data": [
    { "key": "budget", "label": "Budget", "type": "NUMBER", "source": "allo" },
    {
      "key": "lead_status",
      "label": "Lead status",
      "type": "DROPDOWN",
      "options": [
        { "key": "hot", "label": "Hot" },
        { "key": "cold", "label": "Cold" }
      ],
      "source": "allo"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 20,
    "total_count": 2,
    "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_FOUNDL'espace de travail 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 custom contact fields
dataobject[]
5 champs
keystring

Unique key of the field within your team

labelstring | null

Display name of the field

typeenum<string>

Value type

TEXTNUMBERDATEBOOLEANDROPDOWN

optionsobject[]

Allowed values. Only set for DROPDOWN fields.

2 champs
keystring
labelstring
sourcestring

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

paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
400
401
403
404
429