Developers
API ReferenceTask

Retrieve tasks list

GET
/project/tasks

Retrieve tasks list

Authorization

apiKey
headerAuthorization<token>

Value for the Authorization header parameter.

Query Parameters

page?integer

The collection page number

Default1
itemsPerPage?integer

The number of items per page

Range0 <= value <= 100
Default30
pagination?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
Formatuuid
cursorId?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

Task collection

  1. response
[index: integer]?
Example Request
curl -X GET 'https://app.icproject.com/api/instance/demo/project/tasks'
Example Response
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "shortCode": "string",    "no": 0,    "name": "string",    "taskTypes": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "decorator": "#78909c",        "categories": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "name": "string"          }        ]      }    ],    "priority": "low",    "storyPoints": 1,    "status": "in-preparation",    "dateStart": "2019-08-24T14:15:22Z",    "dateEnd": "2019-08-24T14:15:22Z",    "finishedAt": "2019-08-24T14:15:22Z",    "finishedBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "shortCode": "string",      "firstName": "string",      "lastName": "string",      "email": "string",      "phoneNumber": "string",      "pictureSm": "string",      "pictureLg": "string"    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "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,    "timePlanned": 0,    "timeReported": 0,    "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",    "projectShortCode": "string",    "projectName": "string",    "projectIsSimple": true,    "stage": "9f09bdb0-89bd-4a1a-b468-0312474f1023",    "stageName": "string",    "board": "a98884d6-3c76-4114-ba9c-216527a5aac1",    "boardShortCode": "string",    "boardName": "string",    "boardColumn": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "decorator": "#78909c",      "status": "todo"    },    "createdBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "shortCode": "string",      "firstName": "string",      "lastName": "string",      "email": "string",      "phoneNumber": "string",      "pictureSm": "string",      "pictureLg": "string"    },    "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    },    "customFields": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "valueId": "b772d050-4ba4-443b-8ca7-cc1e42bdd731",        "name": "string",        "description": "string",        "dataType": "text",        "valueText": "string",        "valueFloat": "string",        "valueDateTime": "2019-08-24T14:15:22Z",        "valueSelectOptions": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "value": "string",            "weight": 0,            "decorator": "#78909c"          }        ],        "valueSelectUsers": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "firstName": "string",            "lastName": "string",            "email": "string",            "pictureSm": "string"          }        ],        "valueDepartment": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string"        }      }    ]  }]

Change order of checklistsItems inside of a checklistPOST

Previous Page

Create a taskPOST

Next Page