For AI agents: markdown of this page — /docs-content-en/entities/delivery-services/handlers.md documentation index — /llms.txt

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

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

curl — OAuth application

Terminal 
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
Fieldsuccess Typeboolean Requiredyes Descriptiontrue on a successful request
Fielddata Typearray Requiredyes DescriptionArray of registered handlers. Empty if no handlers are registered
Fielddata[].id Typeinteger Requiredno DescriptionHandler ID
Fielddata[].name Typestring Requiredno DescriptionHandler name
Fielddata[].code Typestring Requiredno DescriptionHandler code. Pass it as restCode when creating a delivery service
Fielddata[].sort Typeinteger Requiredno DescriptionHandler sort order
Fielddata[].description Typestring Requiredno DescriptionHandler description
Fielddata[].settings Typeobject | array Requiredno DescriptionHandler settings. Nested keys retain their Bitrix24 names
Fielddata[].profiles Typearray Requiredno DescriptionHandler profile definitions. Nested keys retain their Bitrix24 names
Fieldmeta Typeobject Requiredyes DescriptionHandler count metadata
Fieldmeta.total Typeinteger Requiredyes DescriptionNumber 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
HTTP400 CodeINVALID_PARAMS DescriptionAny query parameter is present in the URL. Call this method without query parameters
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionThe response structure or a numeric field value is invalid
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no available Bitrix24 tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the delivery scope
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request. The reason is in error.message

For all common API errors, see Errors.

See also