Task

Retrieve Task

GET

Retrieve a Task by its unique identifier or by its short ID. A Task has both a unique identifier, which is a GUID, and a short ID, which is a small text label that is unique only within your Workspace.

A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection.

Path parameters

taskIdstringRequired
The unique identifier or short ID of the Task to retrieve

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection.
GET
1curl /api/data/tasks/taskId \
2 -H "Authorization: Bearer <token>"
200
Retrieved
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue",
12 "data": {
13 "id": "id",
14 "project": {
15 "id": "id",
16 "shortId": "shortId",
17 "name": "name"
18 },
19 "tags": [
20 {}
21 ],
22 "projectId": "projectId",
23 "assignees": [
24 {}
25 ],
26 "todos": [
27 {}
28 ],
29 "shortId": "shortId",
30 "name": "name",
31 "description": "description",
32 "status": {
33 "id": "id",
34 "projectId": "projectId",
35 "name": "name",
36 "order": 1,
37 "isDone": true
38 },
39 "plannedStartDate": "plannedStartDate",
40 "plannedFinishDate": "plannedFinishDate",
41 "actualStartDate": "actualStartDate",
42 "actualFinishDate": "actualFinishDate",
43 "actualEffort": 1,
44 "modifyDate": "2024-01-15T09:30:00Z",
45 "createDate": "2024-01-15T09:30:00Z",
46 "percentComplete": 1,
47 "isSummary": true,
48 "priorityId": 1,
49 "wbs": "wbs",
50 "color": "color",
51 "actualCost": 1.1,
52 "actualResourceCost": 1.1,
53 "plannedCost": 1.1,
54 "plannedResourceCost": 1.1,
55 "plannedDuration": 1,
56 "plannedEffort": 1,
57 "fields": [
58 {}
59 ],
60 "fieldValues": [
61 {}
62 ],
63 "files": [
64 {}
65 ]
66 }
67}