Ressourcen

Eigene Felder

Jeder Eigene Felder-Endpunkt, mit dem Scope, den er durchsetzt, dem Körper, den er annimmt, einer lesbaren Antwort und den Ablehnungen, die er zurückgeben kann.

Die eigenen Felder des Arbeitsbereichs auflisten, einschließlich archivierter Felder.

get/organizations/{organization}/custom-fields

Scope: passports:read
Idempotency-Key: Wird nicht akzeptiert
Liefert: 200

Pfadparameter

organizationZeichenkettePflicht

Die Organisation, für die diese Anfrage handelt. Der Zugangsschlüssel muss dafür freigegeben sein.

Fehler

Jede Ablehnung, die dieser Endpunkt zurückgeben kann, samt dem HTTP-Status, mit dem sie eintrifft.

Anfrage

curl "https://passportcraft.com/api/v1/organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/custom-fields" \
  -H "Authorization: Bearer $PASSPORTCRAFT_API_KEY"

Antwort · 200

{
  "object": "list",
  "data": [
    {
      "object": "custom_field",
      "key": "guarantee",
      "label": "Guarantee",
      "label_lang": "en",
      "help": "Years of manufacturer guarantee",
      "type": "number",
      "unit": "ANN",
      "options": null,
      "environmental": false,
      "status": "active",
      "position": 0,
      "created_at": "2026-08-01T09:12:44.918Z",
      "updated_at": "2026-08-01T09:12:44.918Z"
    },
    {
      "object": "custom_field",
      "key": "old_care_notes",
      "label": "Old care notes",
      "label_lang": "en",
      "help": null,
      "type": "text",
      "unit": null,
      "options": null,
      "environmental": false,
      "status": "archived",
      "position": 1,
      "created_at": "2026-08-01T09:12:44.918Z",
      "updated_at": "2026-08-02T10:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET /organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/custom-fields