Retrieve Project — Project Manager

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.

Headers

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Response

This endpoint returns an object.

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

dataobjectOptional

1 curl https://api.projectmanager.com/api/data/projects/projectId \ 2 -H "Authorization: Bearer <token>"

1 { 2 "error": { 3 "technicalError": "technicalError", 4 "additionalErrors": [ 5 "additionalErrors" 6 ], 7 "validationErrors": { 8 "key": [ 9 "value" 10 ] 11 }, 12 "message": "message" 13 }, 14 "success": true, 15 "hasError": true, 16 "statusCode": "Continue", 17 "data": { 18 "id": "id", 19 "name": "name", 20 "description": "description", 21 "shortCode": "shortCode", 22 "shortId": "shortId", 23 "folder": { 24 "id": "id", 25 "name": "name" 26 }, 27 "status": { 28 "id": "id", 29 "name": "name", 30 "isDeleted": true 31 }, 32 "startDate": "startDate", 33 "endDate": "endDate", 34 "targetDate": "targetDate", 35 "plannedStartDate": "plannedStartDate", 36 "plannedFinishDate": "plannedFinishDate", 37 "actualStartDate": "actualStartDate", 38 "actualFinishDate": "actualFinishDate", 39 "priority": { 40 "id": "id", 41 "name": "name" 42 }, 43 "chargeCode": { 44 "id": "id", 45 "name": "name" 46 }, 47 "manager": { 48 "id": "id", 49 "name": "name", 50 "initials": "initials", 51 "avatarUrl": "avatarUrl" 52 }, 53 "customer": { 54 "id": "id", 55 "name": "name" 56 }, 57 "budget": 1.1, 58 "hourlyRate": 1.1, 59 "statusUpdate": "statusUpdate", 60 "modifyDate": "2024-01-15T09:30:00Z", 61 "createDate": "2024-01-15T09:30:00Z", 62 "isTemplate": true, 63 "favorite": true, 64 "creationTemplateId": "creationTemplateId", 65 "members": [ 66 {} 67 ], 68 "fieldValues": [ 69 {} 70 ], 71 "files": [ 72 {} 73 ], 74 "percentComplete": 1, 75 "fields": { 76 "key": "value" 77 } 78 } 79 }

1	curl https://api.projectmanager.com/api/data/projects/projectId \
2	-H "Authorization: Bearer <token>"

1	{
2	"error": {
3	"technicalError": "technicalError",
4	"additionalErrors": [
5	"additionalErrors"
6	],
7	"validationErrors": {
8	"key": [
9	"value"
10	]
11	},
12	"message": "message"
13	},
14	"success": true,
15	"hasError": true,
16	"statusCode": "Continue",
17	"data": {
18	"id": "id",
19	"name": "name",
20	"description": "description",
21	"shortCode": "shortCode",
22	"shortId": "shortId",
23	"folder": {
24	"id": "id",
25	"name": "name"
26	},
27	"status": {
28	"id": "id",
29	"name": "name",
30	"isDeleted": true
31	},
32	"startDate": "startDate",
33	"endDate": "endDate",
34	"targetDate": "targetDate",
35	"plannedStartDate": "plannedStartDate",
36	"plannedFinishDate": "plannedFinishDate",
37	"actualStartDate": "actualStartDate",
38	"actualFinishDate": "actualFinishDate",
39	"priority": {
40	"id": "id",
41	"name": "name"
42	},
43	"chargeCode": {
44	"id": "id",
45	"name": "name"
46	},
47	"manager": {
48	"id": "id",
49	"name": "name",
50	"initials": "initials",
51	"avatarUrl": "avatarUrl"
52	},
53	"customer": {
54	"id": "id",
55	"name": "name"
56	},
57	"budget": 1.1,
58	"hourlyRate": 1.1,
59	"statusUpdate": "statusUpdate",
60	"modifyDate": "2024-01-15T09:30:00Z",
61	"createDate": "2024-01-15T09:30:00Z",
62	"isTemplate": true,
63	"favorite": true,
64	"creationTemplateId": "creationTemplateId",
65	"members": [
66	{}
67	],
68	"fieldValues": [
69	{}
70	],
71	"files": [
72	{}
73	],
74	"percentComplete": 1,
75	"fields": {
76	"key": "value"
77	}
78	}
79	}