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

Pause task timer

POST /v1/tasks/:taskId/pause-timer

Stops the time-tracking timer the key's user started on a task and records the worked time in the task's time tracking.

Parameters

Parameter Type Required Description
taskId (path) number yes Task ID. List: GET /v1/tasks

Request fields (body)

Field Type Required Description
params object no Additional action parameters. Passed to Bitrix24 unchanged

The request body can be empty or {}. Any field other than params is rejected with 400 INVALID_PARAMS.

Examples

curl — personal key

Terminal 
curl -X POST 'https://vibecode.bitrix24.com/v1/tasks/289/pause-timer' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

curl — OAuth application

Terminal 
curl -X POST 'https://vibecode.bitrix24.com/v1/tasks/289/pause-timer' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

JavaScript — personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/tasks/289/pause-timer', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const result = await response.json()
console.log(result.data)

JavaScript — OAuth application

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/tasks/289/pause-timer', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const result = await response.json()
console.log(result.data)

Response fields

Field Type Description
success boolean true on success
data object | null null if time tracking is off for the task. The call changes nothing in that case
data.task object The full task object when time tracking is on. Values arrive in raw form: numbers as strings ("id": "289"), flags as Y or N ("allowTimeTracking": "Y"). GET /v1/tasks/:id returns the same fields as numbers and true/false
data.task.id string Task ID
data.task.status string Task status. Pausing the timer does not change it: the task stays at 3 — In Progress
data.task.allowTimeTracking string Time tracking for the task: Y — on
data.task.action object Which actions the key's user can take: the key is the action name (start, pause, complete, defer, renew and others), the value is true or false

Response example

Time tracking is on. Only the main fields of the task object are shown:

JSON 
{
  "success": true,
  "data": {
    "task": {
      "id": "289",
      "title": "Prepare the quarterly report",
      "status": "3",
      "createdBy": "1",
      "responsibleId": "1",
      "allowTimeTracking": "Y",
      "timeElapsed": "6",
      "action": {
        "start": false,
        "pause": true,
        "complete": true,
        "defer": false,
        "renew": false
      }
    }
  }
}

Time tracking is off for the task:

JSON 
{
  "success": true,
  "data": null
}

Error response example

422 — no timer is running on the task:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Could not stop the task timer",
    "b24Code": "0"
  }
}

The error.message text comes from Bitrix24, so its wording and language depend on the Bitrix24 account language. Branch on error.code, not on the message text.

Errors

HTTP Code Description
400 INVALID_PARAMS taskId is not a positive integer: taskId must be a positive integer
400 INVALID_PARAMS The request body is not a JSON object: body must be an object
400 INVALID_PARAMS The body contains fields other than params: body contains unsupported fields
400 INVALID_PARAMS params is not an object: params must be an object
401 MISSING_API_KEY X-Api-Key is missing
401 INVALID_API_KEY The key is not found
401 TOKEN_MISSING The key has no valid Bitrix24 token
403 SCOPE_DENIED The key lacks the task or tasks scope
403 WRITE_BLOCKED_READONLY_KEY The key is read-only
403 BITRIX_ACCESS_DENIED The key's user has no rights to the task
422 BITRIX_ERROR Time tracking is on, but no timer is running on the task
422 BITRIX_ERROR No task exists with this taskId: Task not found or not accessible

The full list of common API errors — Errors.

Known specifics

  • Without time tracking the call does nothing, yet the response is successful. If allowTimeTracking is off for the task, you get 200 with data: null. Time tracking is turned on by the allowTimeTracking field when you create or update the task.
  • Pausing the timer does not pause the task. The task stays In Progress. To return it to Pending, call pause task.
  • Where to see the worked time. Each stop adds an entry to the task's time tracking: the start and end of the interval and its length in seconds.

See also