Query Projects — Project Manager

Retrieve a list of Projects that match an OData formatted query.

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.

Headers

x-integration-namestringOptional

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

Query parameters

$topintegerOptional

The number of records to return

$skipintegerOptional

Skips the given number of records and then returns $top records

$filterstringOptional

Filter the expression according to oData queries

$orderbystringOptional

Order collection by this field.

$expandstringOptional

Include related data in the response

Response

Success

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.

datalist of objectsOptional

If the API call succeeded, this will contain the results.

1 curl https://api.projectmanager.com/api/data/projects \ 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 { 19 "id": "id", 20 "name": "name", 21 "description": "description", 22 "shortCode": "shortCode", 23 "shortId": "shortId", 24 "startDate": "startDate", 25 "endDate": "endDate", 26 "targetDate": "targetDate", 27 "plannedStartDate": "plannedStartDate", 28 "plannedFinishDate": "plannedFinishDate", 29 "actualStartDate": "actualStartDate", 30 "actualFinishDate": "actualFinishDate", 31 "budget": 1.1, 32 "hourlyRate": 1.1, 33 "statusUpdate": "statusUpdate", 34 "modifyDate": "2024-01-15T09:30:00Z", 35 "createDate": "2024-01-15T09:30:00Z", 36 "isTemplate": true, 37 "favorite": true, 38 "creationTemplateId": "creationTemplateId", 39 "members": [ 40 {} 41 ], 42 "fieldValues": [ 43 {} 44 ], 45 "files": [ 46 {} 47 ], 48 "percentComplete": 1, 49 "fields": { 50 "key": "value" 51 } 52 } 53 ] 54 }

1	curl https://api.projectmanager.com/api/data/projects \
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	{
19	"id": "id",
20	"name": "name",
21	"description": "description",
22	"shortCode": "shortCode",
23	"shortId": "shortId",
24	"startDate": "startDate",
25	"endDate": "endDate",
26	"targetDate": "targetDate",
27	"plannedStartDate": "plannedStartDate",
28	"plannedFinishDate": "plannedFinishDate",
29	"actualStartDate": "actualStartDate",
30	"actualFinishDate": "actualFinishDate",
31	"budget": 1.1,
32	"hourlyRate": 1.1,
33	"statusUpdate": "statusUpdate",
34	"modifyDate": "2024-01-15T09:30:00Z",
35	"createDate": "2024-01-15T09:30:00Z",
36	"isTemplate": true,
37	"favorite": true,
38	"creationTemplateId": "creationTemplateId",
39	"members": [
40	{}
41	],
42	"fieldValues": [
43	{}
44	],
45	"files": [
46	{}
47	],
48	"percentComplete": 1,
49	"fields": {
50	"key": "value"
51	}
52	}
53	]
54	}