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 styling structure.

Parameters

Parameter Type Req. Description
id (path) number yes Activity ID. Obtained on creation

Examples

Examples are given only for an OAuth application.

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 — 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
success boolean Always true on success
data.activity.id number Activity ID
data.activity.ownerTypeId number CRM 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
data.activity.ownerId number ID of the owner entity
data.activity.fields.typeId string Activity type. For activities without their own type — CONFIGURABLE
data.activity.fields.completed boolean Activity is closed
data.activity.fields.deadline string Due date, ISO 8601. null if not set
data.activity.fields.pingOffsets number[] Offsets in minutes relative to deadline at which reminders were generated. Empty array if there are no reminders
data.activity.fields.isIncomingChannel boolean Activity created from an incoming channel
data.activity.fields.responsibleId number ID of the responsible employee
data.activity.fields.badgeCode string Activity badge code on the kanban. Empty string if not set
data.activity.fields.originatorId string ID of the external data source. null if not set
data.activity.fields.originId string ID of the record in the external source. null if not set
data.activity.layout.icon object Activity icon — the code field
data.activity.layout.header object Header — title. Bitrix24 may add tags marks
data.activity.layout.body object Body — the logo logo and named blocks
data.activity.layout.footer object Footer — buttons buttons and the menu 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": "",
        "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
400 VALIDATION_ERROR id in the path is not a number
404 ENTITY_NOT_FOUND An activity with the given id does not exist
403 SCOPE_DENIED The key lacks the crm scope
401 TOKEN_MISSING The authorization key was passed without a session token in the Authorization: Bearer header

Full list of common API errors — Errors.

Known specifics

Only in application context. An authorization key vibe_app_* with a session token in the Authorization: Bearer header is required. A personal API key vibe_api_* is rejected by Bitrix24 with ERROR_WRONG_CONTEXT.

See also