Get a List of Item Activities v 3.0 crm.[type].activity.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with permission to view the CRM item whose activities are requested
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The crm.<type>.activity.list method returns activities bound to a single CRM item. The object type is set by the <type> segment of the method name, and the item by the ownerId condition in the filter.
The list includes activities with any binding to the item, and each activity is returned with all its bindings. Document and call list activities are not included in the list.
Method Name for the Object Type
|
Object type |
Method |
|
Deal |
|
|
Lead |
|
|
Contact |
|
|
Company |
|
|
Estimate |
|
|
Invoice |
|
|
CRM document |
|
|
SPA |
|
For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field.
The method name is written in lowercase: crm.smartinvoice.activity.list, not crm.smartInvoice.activity.list. If the name is written in a different case, the method returns the "Method Not Found" error.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter* |
Filter in the REST 3.0 format: an array of conditions of the form |
|
select |
List of activity fields to return, for example, Default: all activity fields |
|
order |
Sorting in the Possible direction values:
Default: |
|
pagination |
Pagination object. Parameter description |
Parameter filter
The ownerId condition sets the item whose activities you want to retrieve. Rules for it:
- a single condition at the top level of the filter, with the
=operator and a positive integer ownerIdcannot be specified in a condition group, under negation, with another operator, twice, or outsidefilter- if the item does not exist, is in the Recycle Bin, or you have no permission to view it, the method returns a "not found" error, not an empty list
The other conditions are combined with it by AND. You can filter by id, type, providerId, providerTypeId, isCompleted, assignedById, direction, createdTime, updatedTime, startTime, deadlineTime. REST 3.0 operators and condition groups are supported; the syntax is described in the REST 3.0 overview. A condition group is written with the "type": "filter" key: {"type":"filter","logic":"or","conditions":[...]}.
To find activities without a deadline, use the ["deadlineTime","=",null] condition.
Parameter pagination
|
Name |
Description |
|
limit |
Number of activities per page. Values greater than Default: |
|
page |
Page number, starting from |
|
offset |
Number of activities to skip from the beginning of the list. Default: |
The response does not contain the total number of activities. If a page returns fewer activities than specified in limit, it is the last page.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.activity.list
The examples retrieve open activities of an SPA item with the type ID 1038. For a different object type, replace the method name according to the table above.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["ownerId","=",41],["isCompleted","=",false]],"select":["id","subject","isCompleted","deadlineTime"],"order":{"deadlineTime":"asc"},"pagination":{"limit":50}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.activity.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["ownerId","=",41],["isCompleted","=",false]],"select":["id","subject","isCompleted","deadlineTime"],"order":{"deadlineTime":"asc"},"pagination":{"limit":50},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.activity.list
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ActivityListResult = {
items: Array<{
id: number
subject: string
isCompleted: boolean
deadlineTime: string | null
}>
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<ActivityListResult>(
'crm.smartprocess1038.activity.list',
{
filter: [
['ownerId', '=', 41],
['isCompleted', '=', false],
],
select: ['id', 'subject', 'isCompleted', 'deadlineTime'],
order: {
deadlineTime: 'asc',
},
pagination: {
limit: 50,
},
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Activities:', result.items)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listActivities() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.activity.list',
{
filter: [
['ownerId', '=', 41],
['isCompleted', '=', false],
],
select: ['id', 'subject', 'isCompleted', 'deadlineTime'],
order: {
deadlineTime: 'asc',
},
pagination: {
limit: 50,
},
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Activities:', result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listActivities)
</script>
b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.smartprocess1038.activity.list"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"filter": [
["ownerId", "=", 41],
["isCompleted", "=", False],
],
"select": ["id", "subject", "isCompleted", "deadlineTime"],
"order": {
"deadlineTime": "asc",
},
"pagination": {
"limit": 50,
},
},
prefer_version=3,
)
result = response["result"]
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'crm.smartprocess1038.activity.list',
[
'filter' => [
['ownerId', '=', 41],
['isCompleted', '=', false],
],
'select' => ['id', 'subject', 'isCompleted', 'deadlineTime'],
'order' => [
'deadlineTime' => 'asc',
],
'pagination' => [
'limit' => 50,
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'crm.smartprocess1038.activity.list',
{
filter: [
['ownerId', '=', 41],
['isCompleted', '=', false],
],
select: ['id', 'subject', 'isCompleted', 'deadlineTime'],
order: {
deadlineTime: 'asc',
},
pagination: {
limit: 50,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'crm.smartprocess1038.activity.list',
[
'filter' => [
['ownerId', '=', 41],
['isCompleted', '=', false],
],
'select' => ['id', 'subject', 'isCompleted', 'deadlineTime'],
'order' => [
'deadlineTime' => 'asc',
],
'pagination' => [
'limit' => 50,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.smartprocess1038.activity.list", b24.Params{
"filter": []any{
[]any{"ownerId", "=", 41},
[]any{"isCompleted", "=", false},
},
"select": []string{"id", "subject", "isCompleted", "deadlineTime"},
"order": b24.Params{
"deadlineTime": "asc",
},
"pagination": b24.Params{
"limit": 50,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.smartprocess1038.activity.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
Subject string `json:"subject"`
IsCompleted bool `json:"isCompleted"`
DeadlineTime *string `json:"deadlineTime"`
} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, item := range result.Items {
fmt.Println(item.ID, item.Subject, item.IsCompleted)
}
Response Handling
HTTP status: 200
{
"result": {
"items": [
{
"id": 8463,
"subject": "Call the client back",
"isCompleted": false,
"deadlineTime": "2026-11-20T18:00:00+03:00"
}
]
},
"time": {
"start": 1793711360,
"finish": 1793711360.764732,
"duration": 0.7647318840026855,
"processing": 0,
"date_start": "2026-11-03T16:09:20+03:00",
"date_finish": "2026-11-03T16:09:20+03:00",
"operating_reset_at": 1793711940,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
result.items |
Array of activities with the fields from |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION",
"message": "Error validating request object filters.",
"validation": [
{
"message": "Filter for required field \"ownerId\" is required.",
"field": "filter.ownerId"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass |
|
|
ownerId is a condition of the filter: name it as ["ownerId", "=", N] there. |
Remove |
|
|
DTO |
Filter only by the fields marked in the "Filter" column of the field table |
|
|
DTO |
Sort only by |
|
|
This request requires data type |
Pass a value from the |
Filter Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Filter for required field |
Add the |
Filter Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid filter |
Check the |
Pagination Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Incorrect |
Pass |
Item Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
The item from |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Check the field names in |
Method Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Method |
Check the method name: it is written in lowercase, for example, |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |