Ressources

Champs personnalisés

Chaque point de terminaison Champs personnalisés, avec la portée qu'il impose, le corps qu'il accepte, une réponse lisible et les refus qu'il peut renvoyer.

Lister les champs personnalisés de l’espace de travail, y compris les champs archivés.

get/organizations/{organization}/custom-fields

Portée: passports:read
Idempotency-Key: Non accepté
Renvoie: 200

Paramètres de chemin

organizationchaîneObligatoire

L'organisation pour laquelle cette requête agit. La clé doit disposer d'une autorisation sur celle-ci.

Erreurs

Tous les refus que ce point de terminaison peut renvoyer, avec le statut qui les accompagne.

Requête

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

Réponse · 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