Synupv1
Créer une clé
v1Ressources/Champs personnalisés/getLister les définitions de champs personnalisés

Lister les définitions de champs personnalisés

Renvoie le schéma de champs personnalisés défini pour le type d'entité donné (établissement ou client), dans l'ordre d'affichage dans l'interface.

get/api/v1/custom-fields/definitions
custom-fields:read
Paramètres de requête
entityTypestring (location | client)obligatoire
Le schéma de quel type d'entité lister : "location" ou "client".
Réponse
dataarray of objectfacultatif
idstringfacultatif
Identifiant unique de la définition de champ personnalisé.
entityTypestring (location | client)facultatif
Le type d'entité auquel cette définition s'applique : "location" ou "client".
keystringfacultatif
Slug immuable identifiant ce champ, dérivé de son étiquette à la création. Utilisez-le pour référencer le champ lors de la définition de valeurs.
labelstringfacultatif
L'étiquette d'affichage du champ personnalisé.
typestring (text | number | date | single_select | multi_select)facultatif
Le type de valeur du champ.
requiredbooleanfacultatif
Si le champ est marqué comme requis. Ce n'est pas imposé par l'API — c'est uniquement une indication pour l'interface.
optionsarray of stringfacultatif
Les options sélectionnables du champ, pour les champs single_select et multi_select. Null pour les autres types.
createdBystringfacultatif
Qui a créé cette définition de champ : "user" ou "agent".
ordernumberfacultatif
L'ordre d'affichage du champ par rapport aux autres définitions du même type d'entité, du plus bas au plus élevé.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/custom-fields/definitions
Votre clé API
entityType *
{
  "data": [
    {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": false,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  ]
}