Get a list of running workflows bizproc.workflow.instances

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

  • = — equal
  • ! or != — not equal
  • < — less than
  • <= — less than or equal to
  • > — greater than
  • >= — greater than or equal to

Without a prefix, the filter compares the value for equality. The field name can be passed in any case

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 -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);
        }
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.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,
                },
            ).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}")
        
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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "bizproc.workflow.instances", b24.Params{
        	"SELECT": []string{"ID", "MODIFIED", "OWNED_UNTIL", "MODULE_ID", "ENTITY", "DOCUMENT_ID", "STARTED", "STARTED_BY", "TEMPLATE_ID"},
        	"ORDER": b24.Params{
        		"STARTED": "DESC",
        	},
        	"FILTER": b24.Params{
        		">STARTED_BY": 0,
        	},
        })
        if err != nil {
        	return fmt.Errorf("bizproc.workflow.instances: %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)
        

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

403

ACCESS_DENIED

Access denied!

Method was executed by a non-administrator

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