Task History

Keyset-paginated status moves of a task, newest first. The first page (no cursor) also carries total; follow meta.next_cursor until it is null. Comments are GET /tasks/{id}/comments.

GET/api/v1/tasks/{task_id}/history

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Path parameters

task_idstringrequired

Query parameters

limitinteger

min 1 · max 100 · default: 20

cursorstring | any

opaque keyset cursor from the previous page

Responses

200Successful Response

successboolean

default: true

dataTaskHistoryPage | any

Show properties

Any of:

TaskHistoryPage

transitionsTaskTransition[]required

Show properties

Array of TaskTransition

idstring

task_idstringrequired

actionstring

default: "task.status_changed"

from_statusTaskStatus | any

Show properties

Any of:

TaskStatus

string

any

any

to_statusTaskStatus | any

Show properties

Any of:

TaskStatus

string

any

any

changed_fieldsstring[]

field_changesFieldChange[]

Show properties

Array of FieldChange

fieldstringrequired

beforeany

afterany

before_knownboolean

default: true

changed_variant_fieldsstring[]

actor_idstring | any

Show properties

Any of:

string

string

any

any

atstring<date-time>

includedUserIncludes

People referenced by the payload, keyed by id — same contract as `CreativeIncludes`. Comment authors, mentions and reactors on the comments feed, transition actors on the history one.

Show properties

usersobject

metaCursorMetarequired

`total` is served on the first page only (no cursor).

Show properties

next_cursorstring | any

Show properties

Any of:

string

string

any

any

totalinteger | any

Show properties

Any of:

integer

integer

any

any

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/tasks/string/history" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/tasks/string/history", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/tasks/string/history",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "transitions": [
      {
        "id": "string",
        "task_id": "string",
        "action": "task.status_changed",
        "from_status": "backlog",
        "to_status": "backlog",
        "changed_fields": [
          "string"
        ],
        "field_changes": [
          {
            "field": "string",
            "before": null,
            "after": null,
            "before_known": true
          }
        ],
        "changed_variant_fields": [
          "string"
        ],
        "actor_id": "string",
        "at": "2019-08-24T14:15:22Z"
      }
    ],
    "included": {
      "users": {
        "property1": {
          "id": "string",
          "name": "string",
          "email": "string",
          "image_url": "string"
        },
        "property2": {
          "id": "string",
          "name": "string",
          "email": "string",
          "image_url": "string"
        }
      }
    },
    "meta": {
      "next_cursor": "string",
      "total": 0
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}