Tasks Board Capacity
The capacity board’s opening request: the Ready for Production stack, everything nobody holds, then one column per person holding the work they have across Ready for Production, In Progress, Tech Check and Creative Check — with each column’s load broken down by status.
Columns are the members of the groups asked for (Clerk publicMetadata.groups), by surname,
and every one of them gets a column whether they hold anything or not — which is the point of
the board: an empty column is a person with capacity. Omitting groups draws every group;
someone in no group at all is never a column. points is the effort score summed over
everything the column holds, not over the page of cards returned with it.
unassigned is every capacity status with no assignee — work nobody owns, sectioned by
status like a person’s column. Ready for Production is included, so a queued task nobody holds
is in both stack and unassigned: the same convention the rest of the board follows, where
stack is what is queued and a column is who holds it.
Continue any column with GET /tasks/board?cursor=… and the same rules in query: that
person in assignee (or assignee with the null operator for unassigned) plus the
statuses in status. The cards are one keyset stream per column, so the sections the board
draws are cut out of it client-side.
Assigning is PATCH /tasks/{task_id} with assignee_id; this endpoint only reads.
/api/v1/tasks/board/capacityAuthorizationBearer token · headerrequiredAuthorizationOAuth2 access token · headerrequiredquerystring | anysortstring | anylimitintegersearchstring | anygroupsUserGroup[] | anysuccessbooleandataTasksCapacityBoard | anyShow propertiesHide properties
stackBoardColumnrequiredShow propertiesHide properties
statusTaskStatusrequiredbacklogready_for_productionin_progresstech_checkcreative_checkdonearchivedtasksTaskCard[]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
numberanynext_cursorstring | anyShow propertiesHide properties
stringanytotalintegerunassignedCapacityLoadrequiredShow 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
numberanynext_cursorstring | anyShow propertiesHide properties
stringanytotalintegercreation_pointsnumberexecution_pointsnumbersectionsCapacitySection[]Show propertiesHide properties
CapacitySectionstatusTaskStatusrequiredbacklogready_for_productionin_progresstech_checkcreative_checkdonearchivedtotalintegerrequiredcreation_pointsnumberrequiredexecution_pointsnumberrequiredcolumnsCapacityColumn[]requiredShow propertiesHide properties
CapacityColumntasksTaskCard[]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
numberanynext_cursorstring | anyShow propertiesHide properties
stringanytotalintegercreation_pointsnumberexecution_pointsnumbersectionsCapacitySection[]Show propertiesHide properties
CapacitySectionstatusTaskStatusrequiredbacklogready_for_productionin_progresstech_checkcreative_checkdonearchivedtotalintegerrequiredcreation_pointsnumberrequiredexecution_pointsnumberrequireduser_idstringrequiredincludedTaskIncludesShow 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
stringanyanymessagestring | anyShow propertiesHide properties
stringanyerrorsstring[] | anyShow propertiesHide properties
stringstringanydetailValidationError[]Show propertiesHide properties
ValidationErrorlocstring | integer[]requiredShow propertiesHide properties
string | integerstringintegermsgstringrequiredtypestringrequiredinputanyctxobjectcurl -X GET "/api/v1/tasks/board/capacity" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("/api/v1/tasks/board/capacity", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_TOKEN"
}
});import requests
response = requests.get(
"/api/v1/tasks/board/capacity",
headers={
"Authorization": "Bearer YOUR_TOKEN"
},
){
"success": true,
"data": {
"stack": {
"status": "backlog",
"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
}
],
"next_cursor": "string",
"total": 0
},
"unassigned": {
"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
}
],
"next_cursor": "string",
"total": 0,
"creation_points": 0,
"execution_points": 0,
"sections": [
{
"status": "backlog",
"total": 0,
"creation_points": 0,
"execution_points": 0
}
]
},
"columns": [
{
"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
}
],
"next_cursor": "string",
"total": 0,
"creation_points": 0,
"execution_points": 0,
"sections": [
{
"status": "backlog",
"total": 0,
"creation_points": 0,
"execution_points": 0
}
],
"user_id": "string"
}
],
"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"
}
]
}
},
"message": "string",
"errors": [
"string"
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}