Tasks Board
Keyset-paginated, field-trimmed feed for the kanban board and its table view. The
first page (no cursor) also carries total; follow meta.next_cursor until it is null.
Filter by status with the regular query-builder query param, e.g.
{"combinator":"and","rules":[{"field":"status","operator":"in","value":["backlog"]}]}
— this is how the board continues a single kanban column past its first page.
search is the toolbar’s search box: a case-insensitive substring of the task’s name
or generated_name, ANDed with whatever query narrows to. An all-digit term is read as
a task number instead — it matches number, and in the names only where it stands as a
whole number.
The board’s opening request is GET /tasks/board/columns, which returns every column
at once; the filter/sort/status schemas live on GET /tasks/schema.
/api/v1/tasks/boardAuthorizationBearer token · headerrequiredAuthorizationOAuth2 access token · headerrequiredquerystring | anysortstring | anylimitintegercursorstring | anysearchstring | anysuccessbooleandataTasksBoardPage | anyShow propertiesHide properties
tasksTaskCard[]requiredShow propertiesHide properties
TaskCardidstringrequirednamestringrequirednumberinteger | anyShow propertiesHide properties
integeranygenerated_namestring | anyShow propertiesHide properties
stringanystatusTaskStatusbacklogready_for_productionin_progresstech_checkcreative_checkdonearchivedtest_statusTestStatusnot_testedin_testtestedpausedtask_typeTaskType | anyShow propertiesHide properties
stringanywork_streamWorkStream | anyShow propertiesHide properties
stringanyproduct_idstring | anyShow propertiesHide properties
stringanymedia_typeMediaType | anyShow propertiesHide properties
stringanysourceSource | anyShow propertiesHide properties
stringanycreation_complexityinteger | anyShow propertiesHide properties
integeranyexecution_complexityinteger | anyShow propertiesHide properties
integeranypriorityinteger | anyShow propertiesHide properties
integeranyassignee_idstring | anyShow propertiesHide properties
stringanytask_owner_idstring | anyShow propertiesHide properties
stringanydeadline_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anymanual_launchbooleanlaunched_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anycountinteger | anyShow propertiesHide properties
integeranyresolutionResolution | anyShow propertiesHide properties
stringanygeoGeo | anyShow propertiesHide properties
stringanylanguageLanguage | anyShow propertiesHide properties
stringanyvaried_elementsVariedElement[]subjectstring | anyShow propertiesHide properties
stringanytopicstring | anyShow propertiesHide properties
stringanyprimary_anchorPrimaryAnchor | anyShow propertiesHide properties
stringanyaudiencestring | anyShow propertiesHide properties
stringanyawareness_stageAwarenessStage | anyShow propertiesHide properties
stringanymessaging_angleMessagingAngle | anyShow propertiesHide properties
stringanyhook_triggerHookTrigger | anyShow propertiesHide properties
stringanyhook_typeHookType | anyShow propertiesHide properties
stringanyad_formatAdFormat | anyShow propertiesHide properties
stringanytraffic_flowTrafficFlow | anyShow propertiesHide properties
stringanystarted_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anysubmitted_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anycompleted_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anycomment_countintegercreatives_totalintegercreatives_doneintegerautomationTaskCardAutomationShow propertiesHide properties
stateAutomationState | anyShow propertiesHide properties
stringanyerrorstring | anyShow propertiesHide properties
stringanystarted_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anycreated_atstring<date-time>requiredupdated_atstring<date-time>requireddeleted_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anycreation_pointsnumber | anyShow propertiesHide properties
numberanyexecution_pointsnumber | anyShow propertiesHide properties
numberanyincludedTaskIncludesShow propertiesHide properties
usersobjectproductsobjectcreativesobjecttask_creativesCreativeItem[]Show propertiesHide properties
CreativeItemidstringrequirednamestringrequiredvariation_numinteger | anyShow propertiesHide properties
integeranyin_work_atstring<date-time> | anyShow propertiesHide properties
string<date-time>anyassignee_idstring | anyShow propertiesHide properties
stringanytask_owner_idstring | anyShow propertiesHide properties
stringanymetaTaskBoardMetarequiredShow propertiesHide properties
next_cursorstring | anyShow propertiesHide properties
stringanytotalinteger | anyShow propertiesHide properties
integeranyanymessagestring | anyShow propertiesHide properties
stringanyerrorsstring[] | anyShow propertiesHide properties
stringstringanydetailValidationError[]Show propertiesHide properties
ValidationErrorlocstring | integer[]requiredShow propertiesHide properties
string | integerstringintegermsgstringrequiredtypestringrequiredinputanyctxobjectcurl -X GET "/api/v1/tasks/board" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("/api/v1/tasks/board", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_TOKEN"
}
});import requests
response = requests.get(
"/api/v1/tasks/board",
headers={
"Authorization": "Bearer YOUR_TOKEN"
},
){
"success": true,
"data": {
"tasks": [
{
"id": "string",
"name": "string",
"number": 0,
"generated_name": "string",
"status": "backlog",
"test_status": "not_tested",
"task_type": "NEW",
"work_stream": "Performance",
"product_id": "string",
"media_type": "VID",
"source": "META",
"creation_complexity": 0,
"execution_complexity": 0,
"priority": 0,
"assignee_id": "string",
"task_owner_id": "string",
"deadline_at": "2019-08-24T14:15:22Z",
"manual_launch": false,
"launched_at": "2019-08-24T14:15:22Z",
"count": 0,
"resolution": "1080x1920",
"geo": "US",
"language": "EN",
"varied_elements": [
"hook"
],
"subject": "string",
"topic": "string",
"primary_anchor": "pain_led",
"audience": "string",
"awareness_stage": "unaware",
"messaging_angle": "pattern_interrupt",
"hook_trigger": "pattern_interrupt",
"hook_type": "pattern_interrupt",
"ad_format": "animation",
"traffic_flow": "W2A",
"started_at": "2019-08-24T14:15:22Z",
"submitted_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"comment_count": 0,
"creatives_total": 0,
"creatives_done": 0,
"automation": {
"state": "pending",
"error": "string",
"started_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"creation_points": 0,
"execution_points": 0
}
],
"included": {
"users": {
"property1": {
"id": "string",
"name": "string",
"email": "string",
"image_url": "string"
},
"property2": {
"id": "string",
"name": "string",
"email": "string",
"image_url": "string"
}
},
"products": {
"property1": {
"id": "string",
"name": "string"
},
"property2": {
"id": "string",
"name": "string"
}
},
"creatives": {
"property1": {
"id": "string",
"name": "string",
"variation_num": 0,
"in_work_at": "2019-08-24T14:15:22Z",
"assignee_id": "string",
"task_owner_id": "string"
},
"property2": {
"id": "string",
"name": "string",
"variation_num": 0,
"in_work_at": "2019-08-24T14:15:22Z",
"assignee_id": "string",
"task_owner_id": "string"
}
},
"task_creatives": [
{
"id": "string",
"name": "string",
"variation_num": 0,
"in_work_at": "2019-08-24T14:15:22Z",
"assignee_id": "string",
"task_owner_id": "string"
}
]
},
"meta": {
"next_cursor": "string",
"total": 0
}
},
"message": "string",
"errors": [
"string"
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}