Retrieve Project | Project Manager

1 curl /project-api/public/projects/projectId \ 2 -H "Authorization: Bearer <token>"

1 { 2 "error": { 3 "message": "message" 4 }, 5 "success": true, 6 "hasError": true, 7 "statusCode": "Continue", 8 "data": { 9 "id": "id", 10 "name": "name", 11 "description": "description", 12 "shortCode": "shortCode", 13 "shortId": "shortId", 14 "folder": { 15 "id": "id", 16 "name": "name" 17 }, 18 "status": { 19 "id": "id", 20 "name": "name" 21 }, 22 "startDate": "2024-01-15T09:30:00Z", 23 "endDate": "2024-01-15T09:30:00Z", 24 "targetDate": "targetDate", 25 "priority": { 26 "id": "id", 27 "name": "name" 28 }, 29 "chargeCode": { 30 "id": "id", 31 "name": "name" 32 }, 33 "manager": { 34 "id": "id", 35 "name": "name" 36 }, 37 "customer": { 38 "id": "id", 39 "name": "name" 40 }, 41 "budget": 1.1, 42 "hourlyRate": 1.1, 43 "statusUpdate": "statusUpdate", 44 "modifyDate": "2024-01-15T09:30:00Z", 45 "createDate": "2024-01-15T09:30:00Z", 46 "isTemplate": true 47 } 48 }

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.

errorobject or null

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

successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null

True if the API call failed.

statusCodeenum or null

The HTTP code of the response.

dataobject or null

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

Headers

Response