Project

Retrieve Project

GET

Retrieves a project based on its unique identifier.

A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project.

Path parameters

projectIdstringRequired
The unique identifier of the Project 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 Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project.
GET
$curl /api/data/projects/projectId \
>     -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    "id": "id",
14    "name": "name",
15    "description": "description",
16    "shortCode": "shortCode",
17    "shortId": "shortId",
18    "folder": {
19      "id": "id",
20      "name": "name"
21    },
22    "status": {
23      "id": "id",
24      "name": "name",
25      "isDeleted": true
26    },
27    "startDate": "startDate",
28    "endDate": "endDate",
29    "targetDate": "targetDate",
30    "plannedStartDate": "plannedStartDate",
31    "plannedFinishDate": "plannedFinishDate",
32    "actualStartDate": "actualStartDate",
33    "actualFinishDate": "actualFinishDate",
34    "priority": {
35      "id": "id",
36      "name": "name"
37    },
38    "chargeCode": {
39      "id": "id",
40      "name": "name"
41    },
42    "manager": {
43      "id": "id",
44      "name": "name",
45      "initials": "initials",
46      "avatarUrl": "avatarUrl"
47    },
48    "customer": {
49      "id": "id",
50      "name": "name"
51    },
52    "budget": 1.1,
53    "hourlyRate": 1.1,
54    "statusUpdate": "statusUpdate",
55    "modifyDate": "2024-01-15T09:30:00Z",
56    "createDate": "2024-01-15T09:30:00Z",
57    "isTemplate": true,
58    "favorite": true,
59    "creationTemplateId": "creationTemplateId",
60    "members": [
61      {}
62    ],
63    "fields": {
64      "fields": {
65        "key": "value"
66      }
67    },
68    "fieldValues": [
69      {}
70    ],
71    "files": [
72      {}
73    ]
74  }
75}
Built with