For AI agents: markdown of this page — /docs-content-en/automation/workflows/list.md documentation index — /llms.txt

List of running workflows

GET /v1/workflows

Returns running workflow instances in your Bitrix24 account, sorted by modification date (newest first).

Parameters

Parameter Type Description
ParametertemplateId Typenumber DescriptionFilter by workflow template ID. List: GET /v1/bizproc-templates
ParameterstartedBy Typenumber DescriptionFilter by the ID of the user who started the process. List: GET /v1/users
Parameterlimit Typenumber DescriptionNumber of records to return. Default 50, maximum 500. A value outside the range is clamped to the nearest bound
Parameteroffset Typenumber DescriptionOffset for pagination. Default 0

When limit > 50, the response is assembled from several sequential reads of 50 records — response time grows with limit.

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/workflows \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/workflows \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/workflows', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data, meta } = await res.json()
console.log(`Processes: ${meta.total}`, data)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/workflows', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of workflow instances
Fielddata[].id Typestring DescriptionUnique instance identifier. Pass it to DELETE /v1/workflows/:id
Fielddata[].modifiedAt Typestring DescriptionLast modification date (ISO 8601)
Fielddata[].ownedUntil Typestring | null DescriptionExecution lock date for the current step. null if not locked
Fielddata[].moduleId Typestring DescriptionEntity module (for example crm)
Fielddata[].entity Typestring DescriptionDocument class (for example CCrmDocumentDeal)
Fielddata[].documentId Typestring DescriptionDocument identifier in TYPENAME_ID format (for example DEAL_5141)
Fielddata[].startedAt Typestring DescriptionStart date (ISO 8601)
Fielddata[].startedBy Typestring DescriptionID of the user who started the process ("0" — started by the system). Returned as a string; the startedBy filter takes a number. List: GET /v1/users
Fielddata[].templateId Typestring DescriptionWorkflow template ID. Returned as a string; the templateId filter takes a number. List: GET /v1/bizproc-templates
Fieldmeta.total Typenumber DescriptionTotal number of instances found

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": "69f0c2d5ade389.22457798",
      "modifiedAt": "2026-04-28T17:23:17+00:00",
      "ownedUntil": null,
      "moduleId": "crm",
      "entity": "CCrmDocumentDeal",
      "documentId": "DEAL_5141",
      "startedAt": "2026-04-28T17:23:17+00:00",
      "startedBy": "0",
      "templateId": "713"
    }
  ],
  "meta": {
    "total": 1
  }
}

Error response example

403 — no bizproc scope:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'bizproc' scope"
  }
}

Errors

HTTP Code Description
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not provided
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized — no such key exists on the platform
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no connected Bitrix24 tokens
HTTP401 CodeTOKEN_EXPIRED DescriptionThe OAuth user session has expired — re-authorize via /v1/oauth/authorize
HTTP403 CodeSCOPE_DENIED DescriptionThe key is missing the bizproc scope
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access
HTTP409 CodeBIZPROC_MODULE_NOT_ENABLED DescriptionBusiness Processes are not available on the account: the module is not included in the plan, or it is switched off in account settings. Ask an account administrator to enable Business Processes — until then the method returns the same error no matter how many times you retry
HTTP429 CodeRATE_LIMITED DescriptionRequest limit exceeded. Retry in 1–2 seconds
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable

Full list of common API errors — Errors.

Known specifics

  • Only active instances are listed. A workflow that has already finished does not appear here, and no other Vibecode API method returns finished instances. An empty list does not prove that the workflow was never started.
  • documentId is a string, not an array. The field is returned as a string in "TYPENAME_ID" format (for example "DEAL_5141"), not as an array. When starting a process via POST /v1/workflows/start, the document identifier is passed to Bitrix24 as an array, but in this endpoint's response it is normalized to a string.

See also