API ReferenceTask
Retrieves the collection of Task resources as kanban cards
Retrieves the collection of Task resources as kanban cards
Authorization
apiKey Authorization<token>
Value for the Authorization header parameter.
In: header
Query Parameters
page?integer
The collection page number
Default
1itemsPerPage?integer
The number of items per page
Range
0 <= value <= 100Default
30pagination?boolean
Enable or disable pagination
search?string
taskDependency?string
Filter task resources by their dependency.
Value in
- "blocking"
- "waiting"
- "all-blocking"
- "all-waiting"
- "related"
- "finished"
afterDeadline?boolean
finishedAfterDeadline?boolean
dateOverlap?string
order[priority]?string
Default
"asc"Value in
- "asc"
- "desc"
contractors?string
contractors.id[]?string
order[hierarchy]?string
Format
uuidcursorId?string
boardColumn.name_ipartial?string
Filter results by board column name (case-insensitive, partial match)
customFieldValue[{customFieldDefinitionId}]?string
customFieldValueRange[{customFieldDefinitionId}][gt]?string
customFieldValueRange[{customFieldDefinitionId}][lt]?string
customFieldValueRange[{customFieldDefinitionId}][gte]?string
customFieldValueRange[{customFieldDefinitionId}][lte]?string
order[storyPoints]?string
Default
"asc"Value in
- "asc"
- "desc"
leaders?string
leaders.id[]?string
id[]?array<string>
project?string
project[]?array<string>
stage?string
stage[]?array<string>
stage.stageType?string
stage.stageType[]?array<string>
board?string
board[]?array<string>
board.boardType?string
board.boardType[]?array<string>
taskTypes?string
taskTypes[]?array<string>
boardColumn.id?string
boardColumn.id[]?array<string>
boardColumn.status?string
boardColumn.status[]?array<string>
boardColumn.name?string
boardColumn.name[]?array<string>
status?string
status[]?array<string>
priority?string
priority[]?array<string>
assignedTaskUsers.role?string
assignedTaskUsers.role[]?array<string>
assignedTaskUsers.projectUser?string
assignedTaskUsers.projectUser[]?array<string>
assignedTaskUsers.createdBy?string
assignedTaskUsers.createdBy[]?array<string>
taskSubscriptions.projectUser?string
taskSubscriptions.projectUser[]?array<string>
storyPoints?integer
storyPoints[]?array<integer>
timePlanned[between]?string
timePlanned[gt]?string
timePlanned[gte]?string
timePlanned[lt]?string
timePlanned[lte]?string
storyPoints[between]?string
storyPoints[gt]?string
storyPoints[gte]?string
storyPoints[lt]?string
storyPoints[lte]?string
timeReported[between]?string
timeReported[gt]?string
timeReported[gte]?string
timeReported[lt]?string
timeReported[lte]?string
dateEnd[before]?string
dateEnd[strictly_before]?string
dateEnd[after]?string
dateEnd[strictly_after]?string
finishedAt[before]?string
finishedAt[strictly_before]?string
finishedAt[after]?string
finishedAt[strictly_after]?string
dateStart[before]?string
dateStart[strictly_before]?string
dateStart[after]?string
dateStart[strictly_after]?string
createdAt[before]?string
createdAt[strictly_before]?string
createdAt[after]?string
createdAt[strictly_after]?string
updatedAt[before]?string
updatedAt[strictly_before]?string
updatedAt[after]?string
updatedAt[strictly_after]?string
excludeIds[]?array<string>
exists[taskTypes]?boolean
exists[assignedTaskUsers]?boolean
exists[taskRepeater]?boolean
order[createdAt]?string
Default
"asc"Value in
- "asc"
- "desc"
order[updatedAt]?string
Default
"asc"Value in
- "asc"
- "desc"
order[dateEnd]?string
Default
"asc"Value in
- "asc"
- "desc"
order[dateStart]?string
Default
"asc"Value in
- "asc"
- "desc"
order[finishedAt]?string
Default
"asc"Value in
- "asc"
- "desc"
order[name]?string
Default
"asc"Value in
- "asc"
- "desc"
Response Body
curl -X GET "https://example.com/project/tasks/as-kanban-cards"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "shortCode": "string", "no": 0, "name": "string", "priority": "low", "taskTypes": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "decorator": "#78909c", "categories": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ] } ], "status": "in-preparation", "boardColumn": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "decorator": "#78909c", "status": "todo" }, "timeReported": 0, "timePlanned": 0, "assignedTaskUsers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "projectUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "shortCode": "string", "firstName": "string", "lastName": "string", "email": "string", "pictureSm": "string", "pictureLg": "string", "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7", "contractorName": "string", "canLogIn": true, "phoneNumber": "string", "jobPositionName": "string", "hourlyRate": null, "isExternal": true, "decorator": "string" }, "timePlanned": 0, "role": "none" } ], "countChecklistItems": 0, "countChecklistItemsChecked": 0, "countFiles": 0, "countComments": 0, "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z", "description": "string", "weight": 0, "lastImageUrl": "string", "finishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e", "createdBySource": "user", "isReadOnly": true, "dependency": "waiting", "permissions": { "canRetrieve": true, "canEdit": true, "canEditDates": true, "canDelete": true, "canSetReadOnly": true, "canChangeStatus": true, "isMovable": true, "canGetReportedClocks": true, "canSeeAssignedTaskUsersTimePlanned": true, "canManageAssignedTaskUsersTimePlanned": true }, "projectShortCode": "string", "projectName": "string", "projectIsSimple": true, "stage": "9f09bdb0-89bd-4a1a-b468-0312474f1023", "stageName": "string", "board": "a98884d6-3c76-4114-ba9c-216527a5aac1", "boardShortCode": "string", "boardName": "string" }]