For AI agents: markdown of this page — /docs-content-en/entities/activities/bindings/list.md documentation index — /llms.txt

List bindings

GET /v1/activities/:activityId/bindings

Returns every CRM entity the activity is bound to. There is always at least one binding — the owner entity set when the activity was created.

Parameters

Parameter Type Required Description
activityId (path) number yes Activity ID. List: GET /v1/activities

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/activities/3631/bindings \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

Terminal 
curl https://vibecode.bitrix24.com/v1/activities/3631/bindings \
  -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/activities/3631/bindings', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
data.forEach(b => console.log(`${b.entityTypeId}:${b.entityId}`))

JavaScript — OAuth app

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

const { data } = await res.json()

Response fields

Field Type Description
success boolean Always true on success
data array Array of bindings
data[].entityTypeId number Numeric CRM entity-type code:
1 — lead
2 — deal
3 — contact
4 — company
7 — quote
31 — invoice
≥128 — smart-process, its code — in GET /v1/smart-processes
data[].entityId number ID of the bound entity

Response example

JSON 
{
  "success": true,
  "data": [
    { "entityTypeId": 2, "entityId": 4219 },
    { "entityTypeId": 3, "entityId": 9 }
  ]
}

Error response example

404 — the activity does not exist:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Element not found"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS activityId is not a positive integer
404 ENTITY_NOT_FOUND No activity exists for the given activityId
403 SCOPE_DENIED The key lacks the crm scope
401 TOKEN_MISSING The key has no configured tokens

Full list of common API errors — Errors.

See also