For AI agents: markdown of this page — /docs-content-en/entities/tasks/flows-get.md documentation index — /llms.txt

Get a flow

GET /v1/tasks/flows/:flowId

Returns a task flow by ID, together with the settings that the flow list omits.

Parameters

Parameter Type Required Description
ParameterflowId (path) Typenumber Requiredyes DescriptionFlow ID. List: GET /v1/tasks/flows

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/tasks/flows/15" \
  -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/tasks/flows/15', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(`${data.name}: ${data.active ? 'enabled' : 'disabled'}`)

JavaScript — OAuth application

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

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.id Typenumber DescriptionFlow ID
Fielddata.creatorId Typenumber DescriptionID of the employee who created the flow. Get: GET /v1/users/:id
Fielddata.ownerId Typenumber DescriptionID of the flow administrator. Get: GET /v1/users/:id
Fielddata.groupId Typenumber DescriptionID of the flow's workgroup. 0 for a demo flow. Get: GET /v1/workgroups/:id
Fielddata.templateId Typenumber DescriptionID of the template used to create tasks in the flow. 0 means no template. Get: GET /v1/task-templates/:templateId
Fielddata.efficiency Typenumber DescriptionFlow efficiency as a percentage
Fielddata.active Typeboolean Descriptiontrue means the flow is enabled
Fielddata.plannedCompletionTime Typenumber DescriptionTime to complete a task, in seconds
Fielddata.activity Typestring DescriptionDate and time of the flow's last activity, ISO 8601 with a time zone offset
Fielddata.name Typestring DescriptionFlow name
Fielddata.description Typestring DescriptionFlow description. An empty string when there is no description
Fielddata.distributionType Typestring DescriptionHow tasks reach assignees: manually — a moderator distributes them, queue — in turn among employees, himself — employees take tasks themselves
Fielddata.responsibleList Typearray DescriptionWho receives the tasks: an array of pairs such as ["user", "1"], where the second element is the employee ID as a string. With manually, this is the moderator. An empty array for a demo flow. List: GET /v1/users
Fielddata.demo Typeboolean Descriptiontrue means the flow is a Bitrix24 demo flow
Fielddata.responsibleCanChangeDeadline Typeboolean Descriptiontrue means the assignee can change the task deadline
Fielddata.matchWorkTime Typeboolean Descriptiontrue means weekends and holidays are skipped when the deadline is calculated
Fielddata.matchSchedule Typeboolean Descriptiontrue means the deadline is counted only in working hours according to the work schedule, excluding weekends and holidays
Fielddata.taskControl Typeboolean Descriptiontrue means a completed task goes to the task creator for review
Fielddata.notifyAtHalfTime Typeboolean Descriptiontrue means the assignee gets a reminder halfway to the deadline
Fielddata.notifyOnQueueOverflow Typenumber | null DescriptionThe administrator is notified when the number of pending tasks in the flow exceeds this value. null means the notification is off
Fielddata.notifyOnTasksInProgressOverflow Typenumber | null DescriptionThe administrator is notified when the number of tasks in progress exceeds this value. null means the notification is off
Fielddata.notifyWhenEfficiencyDecreases Typenumber | null DescriptionThe administrator is notified when flow efficiency drops below this value, as a percentage. null means the notification is off
Fielddata.taskCreators Typearray DescriptionWho can create tasks in the flow: pairs of the same form as in responsibleList. ["meta-user", "all-users"] means all employees
Fielddata.team Typearray DescriptionEmployees who receive the flow's tasks: pairs of the same form as in responsibleList. An empty array for a demo flow
Fielddata.trialFeatureEnabled Typeboolean DescriptionInternal Bitrix24 flag

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 15,
    "creatorId": 29,
    "ownerId": 29,
    "groupId": 57,
    "templateId": 0,
    "efficiency": 0,
    "active": true,
    "plannedCompletionTime": 432000,
    "activity": "2025-02-06T16:13:59+00:00",
    "name": "Request handling",
    "description": "Customer service requests",
    "distributionType": "himself",
    "responsibleList": [
      [
        "user",
        "1"
      ]
    ],
    "demo": false,
    "responsibleCanChangeDeadline": true,
    "matchWorkTime": true,
    "matchSchedule": false,
    "taskControl": true,
    "notifyAtHalfTime": true,
    "notifyOnQueueOverflow": 50,
    "notifyOnTasksInProgressOverflow": 50,
    "notifyWhenEfficiencyDecreases": 70,
    "taskCreators": [
      [
        "meta-user",
        "all-users"
      ]
    ],
    "team": [
      [
        "user",
        "1"
      ]
    ],
    "trialFeatureEnabled": false
  }
}

Error response example

422 — no flow with this ID exists:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Flow with this ID does not exist.",
    "b24Code": "0"
  }
}

The error.message text comes in the language of the Bitrix24 account.

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionflowId is not a positive integer: flowId must be a positive safe integer
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not found
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key does not have the task or tasks scope
HTTP422 CodeBITRIX_ERROR DescriptionNo flow with this flowId exists, or it was deleted: Flow with this ID does not exist.
HTTP429 CodeRATE_LIMITED DescriptionThe request rate limit of Bitrix24 or the platform was exceeded. Retry after the delay in the Retry-After header

Full list of common API errors — Errors.

See also