GET/projects/{id}.json

Retrieve a Single Project

Returns a single project identified by its integer ID.

Path Params

Name
id
Type
string
required
Description

Query Params

Name
includePeople
Type
boolean
Description
You can pass includePeople=true as an optional parameter to get an array of ID's of all people associated with each project included in the response under the field people
Default
false
Name
projectOwnerIds
Type
string
Description
Name
projectHealth
Type
string
Description
Name
includeProjectOwner
Type
boolean
Description
Default
false
Name
userId
Type
string
Description

Responses

Code
200
Type
object
Schema
Description
200 Response

Examples

200 Response

application/json

{
  "project": {
    "replyByEmailEnabled": true,
    "starred": false,
    "show-announcement": false,
    "harvest-timers-enabled": false,
    "subStatus": "upcoming",
    "status": "active",
    "integrations": {
      "xero": {
        "countrycode": "",
        "enabled": false,
        "connected": "NO",
        "organisation": "",
        "basecurrency": ""
      },
      "sharepoint": {
        "enabled": false,
        "folder": "root",
        "account": "",
        "foldername": "root"
      },
      "microsoftConnectors": {
        "enabled": false
      },
      "onedrivebusiness": {
        "enabled": false
      }
    },
    "defaultPrivacy": "open",
    "created-on": "2020-04-28T16:00:38Z",
    "filesAutoNewVersion": false,
    "category": {
      "name": "",
      "id": "",
      "color": ""
    },
    "tags": [],
    "overview-start-page": "default",
    "logo": "",
    "startDate": "20200429",
    "id": "1",
    "last-changed-on": "2020-04-28T16:02:40Z",
    "portfolioBoards": [],
    "type": "normal",
    "endDate": "20200730",
    "company": {
      "name": "[9999] Holly's Web Agency",
      "id": "1"
    },
    "tasks-start-page": "board",
    "active-pages": {
      "links": "1",
      "tasks": "1",
      "time": "1",
      "billing": "1",
      "notebooks": "1",
      "files": "1",
      "comments": "1",
      "riskRegister": "1",
      "milestones": "1",
      "messages": "1"
    },
    "name": "Website Redesign",
    "privacyEnabled": false,
    "description": "Project to manage website redesign tasks and milestones.",
    "announcement": "",
    "directFileUploadsEnabled": true,
    "start-page": "projectoverview",
    "skipWeekends": false,
    "notifyeveryone": false,
    "boardData": {},
    "announcementHTML": ""
  },
  "STATUS": "OK"
}

Download Swagger