Resources

Custom fields

Every Custom fields endpoint, with the scope it enforces, the body it takes, a response you can read, and the refusals it can return.

List the workspace’s custom fields, including archived fields.

get/organizations/{organization}/custom-fields

Scope: passports:read
Idempotency-Key: Not accepted
Returns: 200

Path parameters

organizationstringRequired

The organization this request acts for. The credential must hold a grant for it.

Errors

Every refusal this endpoint can return, with the status it arrives with.

Request

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

Response · 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