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

Get activity

GET /v1/activity-configurable/:id

Returns a configurable activity by ID: its fields and layout structure.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionActivity ID. Returned in data.activity.id on creation. List: GET /v1/activities

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/activity-configurable/8053 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

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

const { data } = await res.json()
console.log(data.activity.fields.typeId, data.activity.layout)

JavaScript — OAuth application

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

const { data } = await res.json()
console.log(data.activity.fields.typeId, data.activity.layout)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe result — the activity in the activity field
Fielddata.activity.id Typenumber DescriptionActivity ID
Fielddata.activity.ownerTypeId Typenumber DescriptionCRM entity type:
1 — lead
2 — deal
3 — contact
4 — company
7 — quote
31 — invoice
≥128 — smart process, the type ID is in GET /v1/smart-processes
Fielddata.activity.ownerId Typenumber DescriptionID of the owner entity
Fielddata.activity.fields.typeId Typestring DescriptionActivity type. For activities without their own type — CONFIGURABLE
Fielddata.activity.fields.completed Typeboolean DescriptionWhether the activity is closed
Fielddata.activity.fields.deadline Typestring DescriptionDue date, ISO 8601. null if not set
Fielddata.activity.fields.pingOffsets Typenumber[] DescriptionOffsets in minutes relative to deadline at which reminders were generated. Empty array if there are no reminders
Fielddata.activity.fields.isIncomingChannel Typeboolean DescriptionWhether the activity was created from an incoming channel
Fielddata.activity.fields.responsibleId Typenumber DescriptionID of the responsible employee
Fielddata.activity.fields.badgeCode Typestring DescriptionActivity badge code on the Kanban board. null if not set
Fielddata.activity.fields.originatorId Typestring DescriptionID of the external data source. null if not set
Fielddata.activity.fields.originId Typestring DescriptionID of the record in the external source. null if not set
Fielddata.activity.layout.icon Typeobject DescriptionActivity icon — the code field
Fielddata.activity.layout.header Typeobject DescriptionHeader — title. The header may carry tags labels
Fielddata.activity.layout.body Typeobject DescriptionBody — the logo and named blocks
Fielddata.activity.layout.footer Typeobject DescriptionBottom section of the activity — buttons and menu

Response example

JSON 
{
  "success": true,
  "data": {
    "activity": {
      "id": 8053,
      "ownerTypeId": 1,
      "ownerId": 2975,
      "fields": {
        "typeId": "CONFIGURABLE",
        "completed": false,
        "deadline": "2025-02-01T01:00:00+00:00",
        "pingOffsets": [],
        "isIncomingChannel": false,
        "responsibleId": 1,
        "badgeCode": null,
        "originatorId": null,
        "originId": null
      },
      "layout": {
        "icon": { "code": "call-completed" },
        "header": { "title": "Incoming call" },
        "body": { "logo": { "code": "call-incoming" }, "blocks": {} },
        "footer": { "buttons": {} }
      }
    }
  }
}

Error response example

404 — activity not found:

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

Errors

HTTP Code Description
HTTP400 CodeVALIDATION_ERROR Descriptionid in the path is not a number
HTTP404 CodeENTITY_NOT_FOUND DescriptionAn activity with the given id does not exist
HTTP404 CodeNOT_FOUND DescriptionBitrix24 responded without an error but did not return the activity. Message: Configurable activity not found
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no tokens configured, or the authorization key was passed without a session token in the Authorization: Bearer header

Full list of common API errors — Errors.

See also