## Field type catalog

`GET /v1/userfields/:entity/types`

Returns the list of available user field types. The list is the same for all CRM entities and for smart processes.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `:entity` (path) | string | yes | Entity: `deals`, `leads`, `contacts`, `companies`, `quotes`, `requisites`. The value does not affect the result — it is used only to verify scope presence. |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/userfields/deals/types" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/userfields/deals/types" \
  -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/userfields/deals/types',
  {
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  }
)
const { success, data } = await res.json()
console.log(`Types available: ${data.length}`)
```

### JavaScript — OAuth application

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of field type objects |
| `data[].ID` | string | Type identifier — used as `userTypeId` in creation and filter requests |
| `data[].title` | string | Display name of the type |

Full list of types from the API response:

| `ID` | `title` |
|------|---------|
| `string` | String |
| `integer` | Integer |
| `double` | Number |
| `boolean` | Yes/No |
| `enumeration` | List |
| `datetime` | Date/Time |
| `date` | Date |
| `money` | Money |
| `url` | Link |
| `address` | Google Map address |
| `file` | File |
| `employee` | Link to a user |
| `crm_status` | Link to CRM directories |
| `iblock_section` | Link to information block sections |
| `iblock_element` | Link to information block elements |
| `crm` | Link to CRM items |

## Response example

```json
{
  "success": true,
  "data": [
    { "ID": "string", "title": "String" },
    { "ID": "integer", "title": "Integer" },
    { "ID": "double", "title": "Number" },
    { "ID": "boolean", "title": "Yes/No" },
    { "ID": "enumeration", "title": "List" },
    { "ID": "datetime", "title": "Date/Time" },
    { "ID": "date", "title": "Date" },
    { "ID": "money", "title": "Money" },
    { "ID": "url", "title": "Link" },
    { "ID": "address", "title": "Google Map address" },
    { "ID": "file", "title": "File" },
    { "ID": "employee", "title": "Link to a user" },
    { "ID": "crm_status", "title": "Link to CRM directories" },
    { "ID": "iblock_section", "title": "Link to information block sections" },
    { "ID": "iblock_element", "title": "Link to information block elements" },
    { "ID": "crm", "title": "Link to CRM items" }
  ]
}
```

## Error response example

400 — unknown entity:

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_ENTITY",
    "message": "Unsupported entity \"foobar\". Supported: deals, leads, contacts, companies, quotes, requisites"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `UNKNOWN_ENTITY` | `:entity` is not in the list of supported entities |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |
| 403 | `SCOPE_DENIED` | The API key does not have the `crm` scope |

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

## Known specifics

**Same result for all entities.** You can call it with any valid `:entity` — the response will be identical. The `:entity` value affects only the scope check.

**System types in fields.** The response of [`GET /v1/userfields/:entity`](/docs/userfields/crm/list) may contain fields with a `userTypeId` that is absent from this catalog — for example `resourcebooking`. These are types that Bitrix24 creates for internal needs.

## See also

- [List entity fields](/docs/userfields/crm/list) — get fields with the `?userTypeId=` filter
- [Create field](/docs/userfields/crm/create) — `userTypeId` is required on creation
- [CRM entity fields](/docs/userfields/crm) — supported entities and field mapping
- [User fields](/docs/userfields) — section overview