Get a list of running workflows bizproc.workflow.instances

Scope: bizproc

Who can execute the method: administrator

This method retrieves a list of running workflows.

bizproc.workflow.instance.list

There is an old method bizproc.workflow.instance.list — an alias for the method bizproc.workflow.instances. It accepts the same parameters and returns the same results.

Support for bizproc.workflow.instance.list is not guaranteed in the future, so we recommend using bizproc.workflow.instances.

Method Parameters

Name `type`	Description
SELECT `array`	An array containing the list of fields to select. You can specify only the fields that are necessary. Available fields: `ID` — identifier of the workflow `MODIFIED` — date of the last modification `OWNED_UNTIL` — time the workflow is locked. The process is considered stuck if the difference between the lock time and the current time is more than 5 minutes `MODULE_ID` — module identifier by document `ENTITY` — entity identifier by document `DOCUMENT_ID` — document identifier `STARTED` — date the workflow was started `STARTED_BY` — who started the workflow `TEMPLATE_ID` — identifier of the workflow template Default value: `['ID', 'MODIFIED', 'OWNED_UNTIL']`
FILTER `object`	An object for filtering the list of running workflows in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. The list of filterable fields is the same as for the `SELECT` parameter. You can specify the type of filtering before the name of the filtered field: `!` — not equal `<` — less than `<=` — less than or equal to `>` — greater than `>=` — greater than or equal to
ORDER `object`	An object for sorting the list of running workflows in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. The list of fields for sorting is the same as for the `SELECT` parameter. The sorting direction can take the following values: `asc` — ascending `desc` — descending Default value: `{'MODIFIED': 'desc'}`
start `integer`	This parameter is used for managing 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 value of the `start` parameter: `start = (N - 1) * 50`, where `N` — the number of the desired page

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["ID","MODIFIED","OWNED_UNTIL","MODULE_ID","ENTITY","DOCUMENT_ID","STARTED","STARTED_BY","TEMPLATE_ID"],"order":{"STARTED":"DESC"},"filter":{">STARTED_BY":0}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.workflow.instances

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["ID","MODIFIED","OWNED_UNTIL","MODULE_ID","ENTITY","DOCUMENT_ID","STARTED","STARTED_BY","TEMPLATE_ID"],"order":{"STARTED":"DESC"},"filter":{">STARTED_BY":0},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.workflow.instances

try
        {
        	const response = await $b24.callMethod(
        		'bizproc.workflow.instances',
        		{
        			select: [
        				'ID',
        				'MODIFIED',
        				'OWNED_UNTIL',
        				'MODULE_ID',
        				'ENTITY',
        				'DOCUMENT_ID',
        				'STARTED',
        				'STARTED_BY',
        				'TEMPLATE_ID'
        			],
        			order: {
        				STARTED: 'DESC'
        			},
        			filter: {
        				'>STARTED_BY': 0
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'bizproc.workflow.instances',
                    [
                        'select' => [
                            'ID',
                            'MODIFIED',
                            'OWNED_UNTIL',
                            'MODULE_ID',
                            'ENTITY',
                            'DOCUMENT_ID',
                            'STARTED',
                            'STARTED_BY',
                            'TEMPLATE_ID'
                        ],
                        'order' => [
                            'STARTED' => 'DESC'
                        ],
                        'filter' => [
                            '>STARTED_BY' => 0
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching workflow instances: ' . $e->getMessage();
        }

BX24.callMethod(
            'bizproc.workflow.instances',
            {
                select: [
                    'ID',
                    'MODIFIED',
                    'OWNED_UNTIL',
                    'MODULE_ID',
                    'ENTITY',
                    'DOCUMENT_ID',
                    'STARTED',
                    'STARTED_BY',
                    'TEMPLATE_ID'
                ],
                order: {
                    STARTED: 'DESC'
                },
                filter: {
                    '>STARTED_BY': 0
                }
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.workflow.instances',
            [
                'select' => [
                    'ID',
                    'MODIFIED',
                    'OWNED_UNTIL',
                    'MODULE_ID',
                    'ENTITY',
                    'DOCUMENT_ID',
                    'STARTED',
                    'STARTED_BY',
                    'TEMPLATE_ID'
                ],
                'order' => [
                    'STARTED' => 'DESC'
                ],
                'filter' => [
                    '>STARTED_BY' => 0
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result":[
                {
                    "DOCUMENT_ID": "LEAD_1",
                    "ENTITY": "CCrmDocumentLead",
                    "ID": "66e412fdc9bd44.36306599",
                    "STARTED": "2024-09-13T10:25:01+00:00",
                    "MODULE_ID": "crm",
                    "OWNED_UNTIL": null,
                    "TEMPLATE_ID": "1",
                    "STARTED_BY": "0"
                },
                {
                    "DOCUMENT_ID":"DEAL_1633",
                    "ENTITY":"CCrmDocumentDeal",
                    "ID":"658c4d3d6a2906.51542462",
                    "STARTED":"2023-12-27T19:13:49+02:00",
                    "MODULE_ID":"crm",
                    "OWNED_UNTIL":null,
                    "TEMPLATE_ID":"212",
                    "STARTED_BY":"57"
                }
            ],
            "total": 2,
            "time": {
                "start": 1726476060.581428,
                "finish": 1726476060.813776,
                "duration": 0.23234796524047852,
                "processing": 0.002630949020385742,
                "date_start": "2024-09-16T08:41:00+00:00",
                "date_finish": "2024-09-16T08:41:00+00:00",
                "operating_reset_at": 1726476660,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	The root element of the response. Contains an array of objects with information about running workflows
total `integer`	The total number of records found
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`403`	`ACCESS_DENIED`	Access denied!	Method was executed by a non-administrator

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Start Workflow

Stop Workflow

Get a list of running workflows bizproc.workflow.instances

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning