## Dictionary fields

`GET /v1/statuses/fields`

Returns a description of all entity fields with their types and attributes.

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/statuses/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/statuses/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/statuses/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/statuses/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()
```


## Response fields

| Field | Type | RO | Description |
|------|-----|:--:|---------|
| `id` | number | yes | Record ID |
| `entityId` | string | | Dictionary type (DEAL_STAGE, SOURCE, etc.) |
| `statusId` | string | | Symbolic code of the value |
| `name` | string | | Name |
| `nameInit` | string | | Original name |
| `sort` | number | | Sort order |
| `color` | string | | Color (HEX) |
| `semantics` | string | | Semantics: `S` — success, `F` — failure, `null` — in progress or no semantics |
| `system` | boolean | yes | System value (cannot be changed or deleted) |
| `categoryId` | number | | Pipeline ID (for `entityId` of the form `DEAL_STAGE_N`) |
| `extra` | object | yes | Additional data for stage dictionaries — nested keys `SEMANTICS` and `COLOR` |

## Response example

`GET /v1/statuses/fields` returns field descriptions under the `data.fields` key (names are camelCase, as in API responses), where each field is `{ type, readonly, label, description }`. The service field `extra` has no `label` or `description`. Plus `data.batch` with the list of available batch operations.

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Unique numeric identifier of the dictionary record." },
      "entityId": { "type": "string", "readonly": false, "label": "Dictionary type", "description": "Dictionary type the record belongs to (for example DEAL_STAGE, SOURCE, STATUS)." },
      "statusId": { "type": "string", "readonly": false, "label": "Value code", "description": "Symbolic code of the value within its dictionary." },
      "name": { "type": "string", "readonly": false, "label": "Name", "description": "Display name of the record." },
      "nameInit": { "type": "string", "readonly": false, "label": "Initial name", "description": "Initial name assigned when the record was created." },
      "sort": { "type": "number", "readonly": false, "label": "Sort", "description": "Sort order within the dictionary." },
      "color": { "type": "string", "readonly": false, "label": "Color", "description": "Value color in HEX format." },
      "semantics": { "type": "string", "readonly": false, "label": "Semantics", "description": "Stage semantics: S — success, F — failure, null — in progress or no semantics." },
      "system": { "type": "boolean", "readonly": true, "label": "System", "description": "A system value that cannot be changed or deleted." },
      "categoryId": { "type": "number", "readonly": false, "label": "Pipeline ID", "description": "Pipeline ID for entityId values of the DEAL_STAGE_N form." },
      "extra": { "type": "object", "readonly": true }
    },
    "batch": ["create", "update", "delete"]
  }
}
```


## Error response example

403 — missing scope:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API key does not have the `crm` scope |
| 401 | `TOKEN_MISSING` | API key was not provided |

Full list of errors — [Errors](/docs/errors).

## See also

- [CRM dictionaries](/docs/entities/statuses) — entity overview
- [List of dictionaries](/docs/entities/statuses/list) — fetch records