## List the custom fields of a project (tenant:forge:read)

`GET /api/forge/v1/projects/{key}/custom-fields`

Module: Forge · operationId: `listForgeCustomFields` · Tag: Configuration · Auth: access token (`Authorization: Bearer <accessToken>`)

Requires `tenant:forge:read` and a project the caller sees.

### Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `key` | path | string | yes | Project key (e.g. APP) |

### Responses

- **200** The custom fields (`application/json`)
- **404** Error (`application/json`)

Fields of the 200 answer:

- `items` (array of CustomField, required)
  - `id` (string (uuid), required): Field id
  - `key` (string, required): Field key: the key in `customFields` of an item; never changes
  - `kind` (string, required): Value type; never changes (one of `text`, `longtext`, `number`, `date`, `datetime`, `bool`, `select`, `multiselect`, `user`, `url`)
  - `label` (string, required): Display label
  - `options` (array of FieldOption, required): Choices of select and multiselect fields
    - `label` (string, required): Display label
    - `value` (string, required): Stored value
    - `color` (string): Color token or #rrggbb (optional)
  - `position` (integer, required): Order in the configuration
  - `required` (boolean, required): Items of the types the field applies to need a value
  - `typeKeys` (array of string, required): Item type keys; empty = every type
  - `version` (integer, required): Optimistic-locking version; send it with PATCH

Example 200 answer:

```json
{
  "items": [
    {
      "id": "9b5c6d7e-8f9a-4b0c-9dbe-5f6a7b8c9d01",
      "key": "story_points",
      "kind": "number",
      "label": "Story Points",
      "options": [],
      "position": 0,
      "required": false,
      "typeKeys": [
        "story",
        "aufgabe",
        "fehler"
      ],
      "version": 1
    }
  ]
}
```

### Example request

```bash
curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/custom-fields' \
  -H "Authorization: Bearer $ACCESS_TOKEN"
```
