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

Get activity

GET /v1/activities/:id

Returns an activity by ID.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionActivity ID. List: GET /v1/activities
Parameterselect (query) Typestring Requiredno DescriptionResponse fields, comma-separated, for example id,subject. Without the parameter, all fields are returned. Names come from Activity fields
Parameterinclude (query) Typestring Requiredno DescriptionRelated employees, comma-separated: responsible, author, editor. See the "Related data" section below

Examples

curl — personal key

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

curl — OAuth application

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

const { success, data } = await res.json()
console.log('Activity:', data.subject, '— completed:', data.completed)

JavaScript — OAuth application

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

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on a successful request
Fielddata Typeobject DescriptionThe activity with all fields. All fields — Activity fields
Fielddata._included Typeobject DescriptionRelated employees. Returned only with the include parameter — see "Related data"

To get an activity together with its related employees, pass the include parameter in the GET request:

GET /v1/activities/1111?include=responsible,author

Available includes — up to three names per request:

Name Source field Key in _included Result
Nameresponsible Source fieldresponsibleId — the responsible person Key in _includedresponsible ResultEmployee card or null
Nameauthor Source fieldauthorId — the author Key in _includedauthor ResultEmployee card or null
Nameeditor Source fieldeditorId — the last editor Key in _includededitor ResultEmployee card or null

The employee card is the same as in the GET /v1/users/:id response. The relation reads an employee, so the key needs the user scope in addition to crm. The result is in the _included field:

JSON 
{
  "success": true,
  "data": {
    "id": 1111,
    "subject": "Sales proposal",
    "ownerTypeId": 3,
    "ownerId": 409,
    "responsibleId": 29,
    "authorId": 1,
    "_included": {
      "responsible": { "id": 29, "name": "Emma", "lastName": "Wilson", "email": "emma.wilson@example.com", "active": false },
      "author": { "id": 1, "name": "John", "lastName": "Brown", "email": "john.brown@example.com", "active": true }
    }
  }
}

The main fields of the activity and the employee are shown. For the full list of card fields, see Employee fields.

Response example

The main fields are shown. Full list: Activity fields.

JSON 
{
  "success": true,
  "data": {
    "id": 3894,
    "typeId": 1,
    "ownerTypeId": 3,
    "ownerId": 17,
    "subject": "Project meeting",
    "description": "Discussing delivery terms",
    "responsibleId": 1,
    "priority": 2,
    "direction": 2,
    "completed": false,
    "startTime": "2026-10-21T07:00:00.000Z",
    "endTime": "2026-10-21T08:00:00.000Z",
    "deadline": "2026-10-21T07:00:00.000Z",
    "createdAt": "2026-10-19T12:08:24.000Z",
    "updatedAt": "2026-10-19T12:08:24.000Z"
  }
}

Error response example

404 — activity not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Activity is not found."
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionActivity with this ID not found
HTTP400 CodeINVALID_PARAMS Descriptionid is not a non-negative integer. Message: id must be a non-negative integer
HTTP400 CodeUNKNOWN_SELECT_FIELD Descriptionselect contains an unknown field. The message lists the allowed names
HTTP400 CodeINVALID_INCLUDE Descriptioninclude contains a name outside the set responsible, author, editor. The response lists the available names
HTTP400 CodeINVALID_INCLUDE Descriptioninclude is not a comma-separated string of names (for example, include[a]=1). The response does not list the names
HTTP400 CodeINCLUDE_LIMIT_EXCEEDED Descriptioninclude contains more than three names, including duplicates
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe key's user has no permission for this activity in Bitrix24
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope
HTTP403 CodeSCOPE_DENIED Descriptioninclude requests a relation to an employee, but the key lacks the user scope. The response names the relation and the missing scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

See also