v1Ressourcen/Custom Fields/getBenutzerdefinierte Feldwerte einer Entität abrufen

Benutzerdefinierte Feldwerte einer Entität abrufen

Liefert die für einen Standort oder Kunden gespeicherten benutzerdefinierten Feldwerte, indiziert nach Feld-Key.

get/api/v1/custom-fields/values

custom-fields:read

Query-Parameter

entityTypestring (location | client)erforderlich

Der Typ der Entität: "location" oder "client".

entityIdstringerforderlich

ID des Standorts oder Kunden, für den Werte gelesen werden sollen.

Antwort

dataobjectoptional

valuesobjectoptional

Die benutzerdefinierten Feldwerte der Entität, indiziert nach Feld-Key. Ein Wert ist eine Zeichenfolge, eine Zahl, ein Array von Zeichenfolgen (bei multi_select) oder nicht vorhanden, wenn nicht gesetzt.

Fehler

400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.

401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.

403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.

404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.

429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.

get/api/v1/custom-fields/values

Ihr API-Schlüssel

entityType *

entityId *

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