[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-userfields\u002Ftasks\u002Flist":3,"docs-tabs-userfields\u002Ftasks\u002Flist":6},{"content":4,"lastmod":5},"## List fields\n\n`GET \u002Fv1\u002Fuserfields\u002Ftasks`\n\nReturns the user and system task fields of the Bitrix24 account. Supports filtering by field type and field name, and choosing the label language.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|---------|\n| `userTypeId` (query) | string | no | Filter by field type. Values come from the [type catalog](\u002Fdocs\u002Fuserfields\u002Ftasks\u002Ftypes). An unknown type returns an empty `data`. Example: `?userTypeId=enumeration` |\n| `fieldName` (query) | string | no | Filter by the full field name with the `UF_` prefix. A name without the prefix matches nothing and returns an empty `data`. Example: `?fieldName=UF_CRM_TASK` |\n| `lang` (query) | string | no | Language code for field labels, for example `en`. Defaults to the key owner's language |\n\nResults are sorted by the `sort` field in ascending order. There is no pagination: all fields come in a single response, and `meta.total` equals the length of `data`.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fuserfields\u002Ftasks?userTypeId=enumeration\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fuserfields\u002Ftasks?userTypeId=enumeration\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fuserfields\u002Ftasks?userTypeId=enumeration',\n  {\n    headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n  }\n)\nconst { success, data, meta } = await res.json()\nconsole.log(`Enumeration fields: ${meta.total}`)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fuserfields\u002Ftasks?userTypeId=enumeration',\n  {\n    headers: {\n      'X-Api-Key': 'YOUR_APP_KEY',\n      'Authorization': 'Bearer USER_SESSION_TOKEN',\n    },\n  }\n)\nconst { success, data, meta } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | Always `true` on success |\n| `data` | array | Array of task fields. Element properties are the same as in the [field card](\u002Fdocs\u002Fuserfields\u002Ftasks\u002Fget): `id`, `fieldName`, `userTypeId`, flags, `settings`, labels, `system`, and for an `enumeration` field, `items` with its options. The labels `editFormLabel`, `listColumnLabel`, `listFilterLabel`, `errorMessage`, `helpMessage` come as a string in the `lang` language, not as an object keyed by language |\n| `meta.total` | number | Number of fields in the response |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 6007969,\n      \"entityId\": \"TASKS_TASK\",\n      \"fieldName\": \"UF_REVIEW_STAGE\",\n      \"userTypeId\": \"enumeration\",\n      \"xmlId\": null,\n      \"sort\": \"100\",\n      \"multiple\": \"N\",\n      \"mandatory\": \"N\",\n      \"showFilter\": \"N\",\n      \"showInList\": \"Y\",\n      \"editInList\": \"Y\",\n      \"isSearchable\": \"N\",\n      \"settings\": {\n        \"DISPLAY\": \"LIST\",\n        \"LIST_HEIGHT\": 1,\n        \"CAPTION_NO_VALUE\": \"\",\n        \"SHOW_NO_VALUE\": \"Y\"\n      },\n      \"editFormLabel\": \"Review stage\",\n      \"listColumnLabel\": \"Review stage\",\n      \"listFilterLabel\": \"Review stage\",\n      \"errorMessage\": \"UF_REVIEW_STAGE\",\n      \"helpMessage\": \"UF_REVIEW_STAGE\",\n      \"system\": false,\n      \"items\": [\n        {\n          \"id\": 4057,\n          \"value\": \"Accepted\",\n          \"sort\": \"500\",\n          \"def\": \"N\",\n          \"xmlId\": \"accepted\"\n        },\n        {\n          \"id\": 4053,\n          \"value\": \"New\",\n          \"sort\": \"500\",\n          \"def\": \"Y\",\n          \"xmlId\": \"new\"\n        },\n        {\n          \"id\": 4055,\n          \"value\": \"In review\",\n          \"sort\": \"500\",\n          \"def\": \"N\",\n          \"xmlId\": \"review\"\n        }\n      ]\n    },\n    {\n      \"id\": 6007971,\n      \"entityId\": \"TASKS_TASK\",\n      \"fieldName\": \"UF_REQUEST_CHANNEL\",\n      \"userTypeId\": \"enumeration\",\n      \"xmlId\": null,\n      \"sort\": \"200\",\n      \"multiple\": \"N\",\n      \"mandatory\": \"N\",\n      \"showFilter\": \"N\",\n      \"showInList\": \"Y\",\n      \"editInList\": \"Y\",\n      \"isSearchable\": \"N\",\n      \"settings\": {\n        \"DISPLAY\": \"LIST\",\n        \"LIST_HEIGHT\": 1,\n        \"CAPTION_NO_VALUE\": \"\",\n        \"SHOW_NO_VALUE\": \"Y\"\n      },\n      \"editFormLabel\": \"Request channel\",\n      \"listColumnLabel\": \"Request channel\",\n      \"listFilterLabel\": \"Request channel\",\n      \"errorMessage\": \"UF_REQUEST_CHANNEL\",\n      \"helpMessage\": \"UF_REQUEST_CHANNEL\",\n      \"system\": false,\n      \"items\": [\n        {\n          \"id\": 4059,\n          \"value\": \"Email\",\n          \"sort\": \"10\",\n          \"def\": \"N\",\n          \"xmlId\": \"7245a0bf104971496996a5fbf538e9da\"\n        },\n        {\n          \"id\": 4061,\n          \"value\": \"Phone\",\n          \"sort\": \"20\",\n          \"def\": \"N\",\n          \"xmlId\": \"fcdd8897d6d423b186180bba744d3d54\"\n        }\n      ]\n    }\n  ],\n  \"meta\": {\n    \"total\": 2\n  }\n}\n```\n\n## Error response example\n\n401 — the `X-Api-Key` header was not passed:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"MISSING_API_KEY\",\n    \"message\": \"API key required. Pass via X-Api-Key header.\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|---------|\n| 403 | `TASK_CUSTOM_FIELDS_UNAVAILABLE` | The portal plan does not include task user fields |\n| 403 | `SCOPE_DENIED` | The API key does not have the `task` scope |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens. For an application key, the `Authorization: Bearer USER_SESSION_TOKEN` header was not passed |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**System fields are returned along with user fields.** The list includes `UF_CRM_TASK`, `UF_TASK_WEBDAV_FILES`, and `UF_MAIL_MESSAGE` with `system: true`. They cannot be changed or deleted — write requests return `403 SYSTEM_FIELD_PROTECTED`.\n\n**Option order is set by `sort`.** Options created without `sort` default to `500` and do not come back in the order they were passed at creation — as with the `UF_REVIEW_STAGE` field in the example above.\n\n## See also\n\n- [Get field](\u002Fdocs\u002Fuserfields\u002Ftasks\u002Fget)\n- [Create field](\u002Fdocs\u002Fuserfields\u002Ftasks\u002Fcreate)\n- [Field types](\u002Fdocs\u002Fuserfields\u002Ftasks\u002Ftypes)\n- [Task fields](\u002Fdocs\u002Fuserfields\u002Ftasks)\n- [Tasks](\u002Fdocs\u002Fentities\u002Ftasks)\n- [User fields](\u002Fdocs\u002Fuserfields)\n","2026-10-15",{},1795344097996]