v1Ressources/Champs personnalisés/getObtenir les valeurs de champs personnalisés d'une entité

Obtenir les valeurs de champs personnalisés d'une entité

Renvoie les valeurs de champs personnalisés stockées sur un établissement ou un client, indexées par clé de champ.

get/api/v1/custom-fields/values

custom-fields:read

Paramètres de requête

entityTypestring (location | client)obligatoire

Le type de l'entité : "location" ou "client".

entityIdstringobligatoire

ID de l'établissement ou du client dont lire les valeurs.

Réponse

dataobjectfacultatif

valuesobjectfacultatif

Les valeurs de champs personnalisés de l'entité, indexées par clé de champ. Une valeur est une chaîne, un nombre, un tableau de chaînes (pour multi_select), ou absente si non définie.

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.

404La ressource est introuvable, ou n'appartient pas à votre agence.

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/values

Votre clé API

entityType *

entityId *

{
  "data": {
    "values": {
      "parking_notes": "Free lot behind the building."
    }
  }
}