## List delivery handlers

`GET /v1/delivery-services/handlers`

Lists registered REST delivery handlers so you can choose a handler before creating a delivery service.

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/delivery-services/handlers" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/delivery-services/handlers" \
  -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/delivery-services/handlers', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(data, meta.total)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/delivery-services/handlers', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()
console.log(data, meta.total)
```

## Response fields

| Field | Type | Required | Description |
|-------|------|:--------:|-------------|
| `success` | boolean | yes | `true` on a successful request |
| `data` | array | yes | Array of registered handlers. Empty if no handlers are registered |
| `data[].id` | integer | no | Handler ID |
| `data[].name` | string | no | Handler name |
| `data[].code` | string | no | Handler code. Pass it as `restCode` when [creating a delivery service](/docs/entities/delivery-services/create) |
| `data[].sort` | integer | no | Handler sort order |
| `data[].description` | string | no | Handler description |
| `data[].settings` | object \| array | no | Handler settings. Nested keys retain their Bitrix24 names |
| `data[].profiles` | array | no | Handler profile definitions. Nested keys retain their Bitrix24 names |
| `meta` | object | yes | Handler count metadata |
| `meta.total` | integer | yes | Number of items in `data` |

## Response example

The example shows the main handler fields. The full structure is listed in the Response fields table above.

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Delivery handler",
      "code": "my_delivery_handler",
      "sort": 250
    }
  ],
  "meta": {
    "total": 1
  }
}
```

## Error response example

400 — query parameters are present in the URL:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Handlers have no query parameters"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|------|-------------|
| 400 | `INVALID_PARAMS` | Any query parameter is present in the URL. Call this method without query parameters |
| 502 | `BITRIX_RESPONSE_INVALID` | The response structure or a numeric field value is invalid |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `TOKEN_MISSING` | The key has no available Bitrix24 tokens |
| 403 | `SCOPE_DENIED` | The key lacks the `delivery` scope |
| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the request. The reason is in `error.message` |

For all common API errors, see [Errors](/docs/errors).

## See also

- [Create a delivery service](/docs/entities/delivery-services/create)
- [Delivery services](/docs/entities/delivery-services)