Get List of Activities crm.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: crm

Who can execute the method: any user

The crm.activity.list method returns a list of activities by filter, taking the current user's permissions into account.

Method Parameters

Required parameters are marked with *

Name
type

Description

select
array

An array of fields of the activity crm.activity.fields that need to be selected. To get the fields COMMUNICATIONS and FILES, specify them in select

filter
object

An object for filtering the selected items in key-value format.

Possible values for field correspond to the fields of the activity crm.activity.fields.

An additional prefix can be assigned to the key to clarify the filter's behavior. Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN (an array is passed as a value)
  • !@— NOT IN (an array is passed as a value)
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for a substring in any position of the string.
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searching for values starting with "mol"
    • "%mol" — searching for values ending with "mol"
    • "%mol%" — searching for values where "mol" can be in any position
  • %= — LIKE (see description above)
  • !% — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides.
  • =% — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searching for values not starting with "mol"
    • "%mol" — searching for values not ending with "mol"
    • "%mol%" — searching for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (see description above)
  • = — equal, exact match (used by default)
  • != - not equal
  • ! — not equal

order
object

A set of key-value pairs for sorting the output results. The keys can use the fields of the activity crm.activity.fields.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

By default, it is sorted by increasing the Start Date field (START_TIME)

start
integer

This parameter is used to control pagination.

The page size of results is always static: 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the number of the desired page

See the description of list methods.

Please note the specific behavior of the filter[BINDINGS] parameter.

An activity can be linked to multiple CRM entities. For example, a call can simultaneously be linked to a lead and a deal; therefore, to retrieve these entities, the crm.activity.list method parameters include a special filter key: BINDINGS.

You must specify an array of system or custom CRM object types for which you need to find a link.

Each object can consist of the OWNER_TYPE_ID keys (entity type identifier) and OWNER_ID keys (entity identifier), either individually or in combination. For example:

"BINDINGS": [
            {"OWNER_TYPE_ID": 2},
            {"OWNER_TYPE_ID": 3}
        ]

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ID":"DESC"},"filter":{"OWNER_TYPE_ID":3,"OWNER_ID":102},"select":["*","COMMUNICATIONS"],"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ID":"DESC"},"filter":{"OWNER_TYPE_ID":3,"OWNER_ID":102},"select":["*","COMMUNICATIONS"],"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.list
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each activity item returned in result[]
        type ActivityItem = {
          ID: string
          OWNER_ID: string
          OWNER_TYPE_ID: string
          TYPE_ID: string
          SUBJECT: string
          CREATED: ISODate | null
          LAST_UPDATED: ISODate | null
          START_TIME: ISODate | null
          END_TIME: ISODate | null
          DEADLINE: ISODate | null
          COMPLETED: string
          STATUS: string
          RESPONSIBLE_ID: string
          DIRECTION: string
          AUTHOR_ID: string
          EDITOR_ID: string
        }
        
        try {
          // crm.activity.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<ActivityItem[]>({
            method: 'crm.activity.list',
            params: {
              order: { ID: 'DESC' },
              filter: {
                OWNER_TYPE_ID: 3,
                OWNER_ID: 102,
              },
              select: ['*', 'COMMUNICATIONS'],
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Activities on page:', result.length, result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listActivities() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.activity.list',
                params: {
                  order: { ID: 'DESC' },
                  filter: {
                    OWNER_TYPE_ID: 3,
                    OWNER_ID: 102,
                  },
                  select: ['*', 'COMMUNICATIONS'],
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Activities on page:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listActivities)
        </script>

Example


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=["ID", "OWNER_TYPE_ID", "OWNER_ID", "SUBJECT", "STATUS", "DEADLINE", "RESPONSIBLE_ID"],
                filter={"OWNER_TYPE_ID": 2, "OWNER_ID": 101, "COMPLETED": "N"},
                order={"ID": "DESC"},
                start=0,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=["ID", "SUBJECT", "STATUS", "DEADLINE"],
                filter={"OWNER_TYPE_ID": 2, "OWNER_ID": 101},
                order={"ID": "ASC"},
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list_fast


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=["ID", "SUBJECT", "STATUS", "DEADLINE"],
                filter={"OWNER_TYPE_ID": 2, "OWNER_ID": 101},
                order={"ID": "DESC"},
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.list',
                    [
                        'order' => [
                            'ID' => 'DESC',
                        ],
                        'filter' => [
                            'OWNER_TYPE_ID' => 3,
                            'OWNER_ID' => 102,
                        ],
                        'select' => [
                            '*',
                            'COMMUNICATIONS',
                        ],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Activities: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting activity list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.activity.list',
            {
                order: {
                    ID: 'DESC',
                },
                filter: {
                    OWNER_TYPE_ID: 3,
                    OWNER_ID: 102,
                },
                select: [
                    '*',
                    'COMMUNICATIONS',
                ],
                start: 0,
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.list',
            [
                'order' => [ 'ID' => 'DESC' ],
                'filter' => [
                    'OWNER_TYPE_ID' => 3,
                    'OWNER_ID' => 102
                ],
                'select' => [ '*', 'COMMUNICATIONS' ],
                'start' => 0
            ]
        );
        
        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.activity.list", b24.Params{
        	"order": b24.Params{
        		"ID": "DESC",
        	},
        	"filter": b24.Params{
        		"OWNER_TYPE_ID": 3,
        		"OWNER_ID":      102,
        	},
        	"select": []string{"*", "COMMUNICATIONS"},
        	"start":  0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.activity.list: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Typical use-cases and scenarios

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "ID": "20",
                    "OWNER_ID": "15",
                    "OWNER_TYPE_ID": "3",
                    "TYPE_ID": "2",
                    "PROVIDER_ID": "VOXIMPLANT_CALL",
                    "PROVIDER_TYPE_ID": "CALL",
                    "PROVIDER_GROUP_ID": null,
                    "ASSOCIATED_ENTITY_ID": "0",
                    "SUBJECT": "Outgoing call Klaus Weber",
                    "CREATED": "2020-09-27T13:26:55+03:00",
                    "LAST_UPDATED": "2021-03-21T20:28:24+03:00",
                    "START_TIME": "2020-09-27T13:25:00+03:00",
                    "END_TIME": "2020-09-27T19:25:00+03:00",
                    "DEADLINE": "2020-09-27T13:25:00+03:00",
                    "COMPLETED": "Y",
                    "STATUS": "2",
                    "RESPONSIBLE_ID": "505",
                    "PRIORITY": "2",
                    "NOTIFY_TYPE": "1",
                    "NOTIFY_VALUE": "15",
                    "DESCRIPTION": "",
                    "DESCRIPTION_TYPE": "1",
                    "DIRECTION": "2",
                    "LOCATION": "",
                    "SETTINGS": [],
                    "ORIGINATOR_ID": null,
                    "ORIGIN_ID": null,
                    "AUTHOR_ID": "505",
                    "EDITOR_ID": "505",
                    "PROVIDER_PARAMS": [],
                    "PROVIDER_DATA": null,
                    "RESULT_MARK": "0",
                    "RESULT_VALUE": null,
                    "RESULT_SUM": null,
                    "RESULT_CURRENCY_ID": null,
                    "RESULT_STATUS": "0",
                    "RESULT_STREAM": "0",
                    "RESULT_SOURCE_ID": null,
                    "AUTOCOMPLETE_RULE": "0"
                },
                // .. 49 more items
            ],
            "next": 50,
            "total": 123456,
            "time": {
                "start": 1724677896.295857,
                "finish": 1724677897.197243,
                "duration": 0.901386022567749,
                "processing": 0.8762130737304688,
                "date_start": "2024-08-26T16:11:36+03:00",
                "date_finish": "2024-08-26T16:11:37+03:00",
                "operating_reset_at": "2024-08-26T16:11:37+03:00",
                "operating": 0.0162130737304688
            }
        }

Returned Data

Name
type

Description

result
array

Array of activities. To get information about the activity structure, see the crm.activity.fields method

time
time

Information about the request execution time

Error Handling

HTTP status: 400, 403

{
            "error": "INVALID_REQUEST",
            "error_description": "Https required"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Specific Examples

How to Use Examples in Documentation

Using BINGINDS

Retrieve fields: Identifier, Title, Owner Type (Entity Type Identifier), Owner (Entity Identifier)

Filter condition: the activity is linked to both a deal and a contact simultaneously

Note

When using multiple pairs in BINDINGS, duplication may occur in the results. For example, when executing the code example below, an activity linked to both entities will be output twice.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ID":"DESC"},"filter":{"BINDINGS":[{"OWNER_TYPE_ID":2},{"OWNER_TYPE_ID":3}]},"select":["*","COMMUNICATIONS"],"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"ID":"DESC"},"filter":{"BINDINGS":[{"OWNER_TYPE_ID":2},{"OWNER_TYPE_ID":3}]},"select":["*","COMMUNICATIONS"],"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.list
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each activity item returned in result[]
        type ActivityItem = {
          ID: string
          OWNER_ID: string
          OWNER_TYPE_ID: string
          TYPE_ID: string
          SUBJECT: string
          CREATED: ISODate | null
          LAST_UPDATED: ISODate | null
          START_TIME: ISODate | null
          END_TIME: ISODate | null
          DEADLINE: ISODate | null
          COMPLETED: string
          STATUS: string
          RESPONSIBLE_ID: string
          DIRECTION: string
          AUTHOR_ID: string
          EDITOR_ID: string
        }
        
        try {
          // crm.activity.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<ActivityItem[]>({
            method: 'crm.activity.list',
            params: {
              order: { ID: 'DESC' },
              filter: {
                BINDINGS: [
                  { OWNER_TYPE_ID: 2 },
                  { OWNER_TYPE_ID: 3 },
                ],
              },
              select: ['*', 'COMMUNICATIONS'],
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Activities matched by bindings on page:', result.length, result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listActivitiesWithBindings() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.activity.list',
                params: {
                  order: { ID: 'DESC' },
                  filter: {
                    BINDINGS: [
                      { OWNER_TYPE_ID: 2 },
                      { OWNER_TYPE_ID: 3 },
                    ],
                  },
                  select: ['*', 'COMMUNICATIONS'],
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Activities matched by bindings on page:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listActivitiesWithBindings)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "COMMUNICATIONS",
                ],
                filter={
                    "BINDINGS": [
                        {
                            "OWNER_TYPE_ID": 2,
                        },
                        {
                            "OWNER_TYPE_ID": 3,
                        },
                    ],
                },
                order={
                    "ID": "DESC",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "COMMUNICATIONS",
                ],
                filter={
                    "BINDINGS": [
                        {
                            "OWNER_TYPE_ID": 2,
                        },
                        {
                            "OWNER_TYPE_ID": 3,
                        },
                    ],
                },
                order={
                    "ID": "DESC",
                },
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list_fast


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "COMMUNICATIONS",
                ],
                filter={
                    "BINDINGS": [
                        {
                            "OWNER_TYPE_ID": 2,
                        },
                        {
                            "OWNER_TYPE_ID": 3,
                        },
                    ],
                },
                order={
                    "ID": "DESC",
                },
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.list',
                    [
                        'order' => [
                            'ID' => 'DESC',
                        ],
                        'filter' => [
                            'BINDINGS' => [
                                [
                                    'OWNER_TYPE_ID' => 2,
                                ],
                                [
                                    'OWNER_TYPE_ID' => 3,
                                ],
                            ],
                        ],
                        'select' => [
                            '*',
                            'COMMUNICATIONS',
                        ],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Activities: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting activity list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.activity.list',
            {
                order: {
                    ID: 'DESC',
                },
                filter: {
                    BINDINGS: [
                        {
                            OWNER_TYPE_ID: 2,
                        },
                        {
                            OWNER_TYPE_ID: 3,
                        },
                    ],
                },
                select: [
                    '*',
                    'COMMUNICATIONS',
                ],
                start: 0,
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.list',
            [
                'order' => ['ID' => 'DESC'],
                'filter' => [
                    'BINDINGS' => [
                        ['OWNER_TYPE_ID' => 2],
                        ['OWNER_TYPE_ID' => 3]
                    ]
                ],
                'select' => ['*', 'COMMUNICATIONS'],
                'start' => 0
            ]
        );
        
        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.activity.list", b24.Params{
        	"order": b24.Params{
        		"ID": "DESC",
        	},
        	"filter": b24.Params{
        		"BINDINGS": []b24.Params{
        			{
        				"OWNER_TYPE_ID": 2,
        			},
        			{
        				"OWNER_TYPE_ID": 3,
        			},
        		},
        	},
        	"select": []string{"*", "COMMUNICATIONS"},
        	"start":  0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.activity.list: %w", err)
        }
        
        var items []struct {
        	ID b24.ID `json:"ID"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }
        
        // Total and Next are filled in by list methods; for a full
        // list traversal, use client.Core().Pages and Scan.
        if res.Total != nil {
        	fmt.Println("total:", *res.Total)
        }

Retrieving COMMUNICATIONS

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"ID":"20"},"select":["*","COMMUNICATIONS"],"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"ID":"20"},"select":["*","COMMUNICATIONS"],"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.list
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CommunicationEntry = {
          ID: string
          TYPE: string
          VALUE: string
          ENTITY_ID: string
          ENTITY_TYPE_ID: string
        }
        
        // Shape of each activity item returned in result[]
        type ActivityItem = {
          ID: string
          OWNER_ID: string
          OWNER_TYPE_ID: string
          SUBJECT: string
          CREATED: ISODate | null
          COMPLETED: string
          STATUS: string
          RESPONSIBLE_ID: string
          COMMUNICATIONS: CommunicationEntry[]
        }
        
        try {
          // crm.activity.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<ActivityItem[]>({
            method: 'crm.activity.list',
            params: {
              filter: {
                ID: '20',
              },
              select: ['*', 'COMMUNICATIONS'],
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Activity ID:', result[0]?.ID, 'Communications:', result[0]?.COMMUNICATIONS)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listActivityCommunications() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.activity.list',
                params: {
                  filter: {
                    ID: '20',
                  },
                  select: ['*', 'COMMUNICATIONS'],
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Activity ID:', result[0]?.ID, 'Communications:', result[0]?.COMMUNICATIONS)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listActivityCommunications)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "COMMUNICATIONS",
                ],
                filter={
                    "ID": "20",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "COMMUNICATIONS",
                ],
                filter={
                    "ID": "20",
                },
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list_fast


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "COMMUNICATIONS",
                ],
                filter={
                    "ID": "20",
                },
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.list',
                    [
                        'filter' => [
                            'ID' => '20',
                        ],
                        'select' => [
                            '*',
                            'COMMUNICATIONS',
                        ],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Activity communications: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting activity communications: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.activity.list',
            {
                filter: {
                    ID: '20',
                },
                select: [
                    '*',
                    'COMMUNICATIONS',
                ],
                start: 0,
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.list',
            [
                'filter' => [
                    'ID' => '20'
                ],
                'select' => ['*', 'COMMUNICATIONS'],
                'start' => 0
            ]
        );
        
        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.activity.list", b24.Params{
        	"filter": b24.Params{
        		"ID": "20",
        	},
        	"select": []string{"*", "COMMUNICATIONS"},
        	"start":  0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.activity.list: %w", err)
        }
        
        var items []struct {
        	ID b24.ID `json:"ID"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }
        
        // Total and Next are filled in by list methods; for a full
        // list traversal, use client.Core().Pages and Scan.
        if res.Total != nil {
        	fmt.Println("total:", *res.Total)
        }

Returned Data Example

HTTP status: 200

{
            "result": [
                {
                "ID": "20",
                "COMMUNICATIONS": [
                    {
                        "ID": "23",
                        "TYPE": "PHONE",
                        "VALUE": "499152222222",
                        "ENTITY_ID": "15",
                        "ENTITY_TYPE_ID": "3",
                        "ENTITY_SETTINGS": {
                            "HONORIFIC": "1",
                            "NAME": "Klaus ",
                            "SECOND_NAME": "Weber",
                            "LAST_NAME": "",
                            "COMPANY_TITLE": "Müller GmbH",
                            "COMPANY_ID": "21"
                        }
                    }
                ]
            }
            ],
            "total": 1,
            "time": {
                "start": 1724659407.69855,
                "finish": 1724659407.723506,
                "duration": 0.02495598793029785,
                "processing": 0.003489971160888672,
                "date_start": "2024-08-26T11:03:27+03:00",
                "date_finish": "2024-08-26T11:03:27+03:00"
            }
        }

Retrieving Attachments

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"ID":"101121"},"select":["*","STORAGE_ELEMENT_IDS"],"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"ID":"101121"},"select":["*","STORAGE_ELEMENT_IDS"],"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.list
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type FileEntry = {
          id: number
          url: string
        }
        
        // Shape of each activity item returned in result[]
        type ActivityItem = {
          ID: string
          OWNER_ID: string
          OWNER_TYPE_ID: string
          SUBJECT: string
          CREATED: ISODate | null
          COMPLETED: string
          STATUS: string
          RESPONSIBLE_ID: string
          FILES: FileEntry[]
        }
        
        try {
          // crm.activity.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<ActivityItem[]>({
            method: 'crm.activity.list',
            params: {
              filter: {
                ID: '101121',
              },
              select: ['*', 'STORAGE_ELEMENT_IDS'],
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Activity ID:', result[0]?.ID, 'Files:', result[0]?.FILES)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listActivityFiles() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.activity.list',
                params: {
                  filter: {
                    ID: '101121',
                  },
                  select: ['*', 'STORAGE_ELEMENT_IDS'],
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Activity ID:', result[0]?.ID, 'Files:', result[0]?.FILES)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listActivityFiles)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "STORAGE_ELEMENT_IDS",
                ],
                filter={
                    "ID": "101121",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "STORAGE_ELEMENT_IDS",
                ],
                filter={
                    "ID": "101121",
                },
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

Example as_list_fast


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.activity.list(
                select=[
                    "*",
                    "STORAGE_ELEMENT_IDS",
                ],
                filter={
                    "ID": "101121",
                },
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.list',
                    [
                        'filter' => [
                            'ID' => '101121',
                        ],
                        'select' => [
                            '*',
                            'STORAGE_ELEMENT_IDS',
                        ],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Activity files: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting activity files: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.activity.list',
            {
                filter: {
                    ID: '101121',
                },
                select: [
                    '*',
                    'STORAGE_ELEMENT_IDS',
                ],
                start: 0,
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.list',
            [
                'filter' => [
                    'ID' => '101121'
                ],
                'select' => ['*', 'STORAGE_ELEMENT_IDS'],
                'start' => 0
            ]
        );
        
        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.activity.list", b24.Params{
        	"filter": b24.Params{
        		"ID": "101121",
        	},
        	"select": []string{"*", "STORAGE_ELEMENT_IDS"},
        	"start":  0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.activity.list: %w", err)
        }
        
        var items []struct {
        	ID b24.ID `json:"ID"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }
        
        // Total and Next are filled in by list methods; for a full
        // list traversal, use client.Core().Pages and Scan.
        if res.Total != nil {
        	fmt.Println("total:", *res.Total)
        }

Returned Data Example

HTTP status: 200

{
            "result": [
                {
                    "ID": "101121",
                    "FILES": [
                        {
                            "id": 3101820,
                            "url": "http://xxx.bitrix24.com/bitrix/tools/crm_show_file.php?fileId=3101820&ownerTypeId=6&ownerId=101121&auth="
                        }
                    ]
                }
            ],
            "total": 1,
            "time": {
                "start": 1724659652.591025,
                "finish": 1724659652.623784,
                "duration": 0.03275895118713379,
                "processing": 0.00624394416809082,
                "date_start": "2024-08-26T11:07:32+03:00",
                "date_finish": "2024-08-26T11:07:32+03:00"
            }
        }

Continue Learning

Previous
Get Activity by ID
Next
Delete Activity