Get the Timeline Records List for the rpa.timeline.listForItem Element

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: rpa

Who can execute the method: any user

DEPRECATED

The development of this method has been halted. Please use Smart processes as an alternative to this functionality.

This method retrieves a list of timeline records for the itemId of the typeId process.

The records are sorted in descending order by creation date, meaning the newest entries appear at the top of the list.

Method Parameters

Name
type

Description

typeId
integer

Identifier of the process

itemId
integer

Identifier of the element

start
integer

This parameter is used for pagination.

The page size for 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 is the desired page number

Response Handling

HTTP Status: 200

{
            "timeline": [
                {
                    "id": 321,
                    "typeId": 24,
                    "itemId": 10,
                    "createdTime": "2020-03-26T20:28:57+02:00",
                    "userId": 1,
                    "title": "Task Completed",
                    "description": "",
                    "action": "task_complete",
                    "isFixed": false,
                    "data": {
                        "item": {
                            "name": "New name"
                        },
                        "scope": "task",
                        "stageFrom": {
                            "id": 30,
                            "name": "Approved by Accountant"
                        },
                        "stageTo": {
                            "id": 31,
                            "name": "Approved"
                        },
                        "fields": [
                            {
                                "name": "UF_RPA_24_NAME",
                                "title": "Name"
                            }
                        ],
                        "task": {
                            "ID": "91",
                            "USER_ID": "1",
                            "WORKFLOW_ID": "5e7cf3e91ef413.27314358",
                            "ACTIVITY": "RpaRequestActivity",
                            "ACTIVITY_NAME": "A79985_79846_49104_50661",
                            "NAME": "Task",
                            "DESCRIPTION": "",
                            "PARAMETERS": {
                                "DOCUMENT_ID": [
                                    "rpa",
                                    "Bitrix\\Rpa\\Integration\\Bizproc\\Document\\Item",
                                    "24:10"
                                ],
                                "TASK_EDIT_URL": "/rpa/task/id/#ID#/",
                                "ACTIONS": [
                                    {
                                        "color": "3bc8f5",
                                        "stageId": "31",
                                        "label": "Save"
                                    }
                                ],
                                "FIELDS_TO_SHOW": [
                                    "UF_RPA_24_NAME",
                                    "UF_RPA_24_STRING_MANDATORY"
                                ],
                                "RESPONSIBLE_TYPE": null,
                                "APPROVE_TYPE": null,
                                "FIELDS_TO_SET": [
                                    "UF_RPA_24_NAME"
                                ]
                            },
                            "USERS": [
                                1
                            ],
                            "INCOMPLETE_USERS": []
                        }
                    },
                    "createdTimestamp": 1585247337000,
                    "users": {
                        "1": {
                            "id": "1",
                            "name": "Anton",
                            "secondName": "",
                            "lastName": "Gorbylev",
                            "title": null,
                            "workPosition": "",
                            "fullName": "Anton Gorbylev",
                            "link": "/company/personal/user/1/"
                        }
                    }
                }
            ]
        }
        

Returned Data

Name

Description

id

Identifier of the record

typeId

Identifier of the process

itemId

Identifier of the element

createdTime

Time of record creation

userId

Identifier of the user who initiated the action

title

Title of the record

description

Text content of the record

action

Action type code

isFixed

Flag indicating if the record is attached

data

Serialized data about the completed action and related entities at the time of record creation. Depending on the action type, it may contain a different set of data

Data Object

Name

Description

item

Data about the element:

  • item[name] — name of the element at the time of action execution

scope

Code of the action source. Can take the value:

  • manual — manually
  • task — when executing a task
  • automation — by Automation rule
  • rest — by application

stageFrom

Data about the original stage at the time of action execution

  • id — identifier
  • name — name

stageTo

Data about the new stage, if it was changed during the action execution

fields

Array of data about fields whose values were changed during the action execution

  • name — field code
  • title — field title

task

Data about the task, if the action was performed while executing a task

users

Data about users who were involved in the action

Error Handling

HTTP Status: 400

{
            "error": "RPA_ITEM_VIEW_ACCESS_DENIED",
            "error_description": "You don't have permission to view this item."
        }
        

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

Possible Error Codes

Status

Code

Description

Value

400

RPA_ITEM_VIEW_ACCESS_DENIED

You don't have permission to view this item

The user cannot view the element. All Bitrix24 employees can view elements; they are not available to extranet users

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

Continue Learning