Task Status

Retrieve Task Statuses

GET

Retrieves the list of TaskStatus levels for a specific Project within your Workspace.

A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business and determine which status levels are considered done.

Path parameters

projectIdstringRequired
The unique identifier of the Project to retrieve TaskStatuses

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
list of objectsOptional
If the API call succeeded, this will contain the results.
GET
$curl /api/data/projects/projectId/tasks/statuses \
>     -H "Authorization: Bearer <token>"
Response
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    {
14      "id": "id",
15      "projectId": "projectId",
16      "name": "name",
17      "order": 1,
18      "isDone": true
19    }
20  ]
21}
Built with