GET/projects.json

Retrieve All Projects

Retrieves all accessible projects. Default returns your active projects.

Project owner can be returned by adding this parameter to this projects endpoint. You can add it to the get all projects call or to the projects/{projectId}.json?=includeProjectOwner=true call.


Query Params

  • Name
    status
    Type
    string
    Description
    You can pass a status option to retrieve projects filtered by status (ALL, ACTIVE, ARCHIVED, CURRENT, LATE, COMPLETED)
    Default
    active
  • Name
    updatedAfterDate
    Type
    string
    Description
    Send back only those projects recently updated after a certain date. Eg. 20100603 - datetime
  • Name
    orderby
    Type
    string
    Description
    Order projects by a parameter, eg companyName, name, lastActivityDate
    Default
    name
  • Name
    createdAfterDate
    Type
    string
    Description
  • Name
    createdAfterTime
    Type
    string
    Description
    Return projects created after a certain time.
  • Name
    catId
    Type
    integer
    Description
    Return projects in a certain category, using cat Id
  • 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
  • Name
    includeProjectOwner
    Type
    boolean
    Description
    The project owner can be returned by adding this parameter to the project's endpoint.
  • Name
    page
    Type
    string
    Description
  • Name
    pageSize
    Type
    number
    Description
    Max page size is 500.
    Default
    500
  • Name
    orderMode
    Type
    string
    Description
    Default
    asc
  • Name
    onlyStarredProjects
    Type
    boolean
    Description
  • Name
    companyId
    Type
    string
    Description
  • Name
    projectOwnerIds
    Type
    string
    Description
  • Name
    searchTerm
    Type
    string
    Description
  • Name
    getDeleted
    Type
    boolean
    Description
  • Name
    includeTags
    Type
    boolean
    Description
  • Name
    userId
    Type
    string
    Description
  • Name
    updatedAfterDateTime
    Type
    string
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "STATUS": "OK",
  "projects": [
    {
      "startDate": "",
      "last-changed-on": "2019-01-03T11:46:14Z",
      "logo": "",
      "created-on": "2018-12-12T10:04:47Z",
      "privacyEnabled": false,
      "status": "active",
      "boardData": {},
      "replyByEmailEnabled": true,
      "harvest-timers-enabled": false,
      "description": "",
      "category": {
        "color": "",
        "id": "",
        "name": ""
      },
      "id": "322852",
      "overview-start-page": "default",
      "start-page": "projectoverview",
      "integrations": {
        "xero": {
          "basecurrency": "",
          "countrycode": "",
          "enabled": false,
          "connected": "NO",
          "organisation": ""
        },
        "sharepoint": {
          "account": "",
          "foldername": "root",
          "enabled": false,
          "folder": "root"
        },
        "microsoftConnectors": {
          "enabled": false
        },
        "onedrivebusiness": {
          "account": "",
          "foldername": "root",
          "enabled": false,
          "folder": "root"
        }
      },
      "defaults": {
        "privacy": ""
      },
      "notifyeveryone": false,
      "filesAutoNewVersion": false,
      "defaultPrivacy": "open",
      "tasks-start-page": "default",
      "starred": false,
      "announcementHTML": "",
      "isProjectAdmin": true,
      "name": "Project 2",
      "company": {
        "is-owner": "1",
        "id": "78494",
        "name": "MCG Company"
      },
      "endDate": "",
      "announcement": "",
      "show-announcement": false,
      "subStatus": "current",
      "tags": []
    },
    {
      "startDate": "",
      "last-changed-on": "2018-12-11T17:52:57Z",
      "logo": "",
      "created-on": "2018-11-26T11:11:00Z",
      "privacyEnabled": false,
      "status": "active",
      "boardData": {},
      "replyByEmailEnabled": true,
      "harvest-timers-enabled": false,
      "description": "",
      "category": {
        "color": "",
        "id": "",
        "name": ""
      },
      "id": "321041",
      "overview-start-page": "default",
      "start-page": "projectoverview",
      "integrations": {
        "xero": {
          "basecurrency": "",
          "countrycode": "",
          "enabled": false,
          "connected": "NO",
          "organisation": ""
        },
        "sharepoint": {
          "account": "",
          "foldername": "root",
          "enabled": false,
          "folder": "root"
        },
        "microsoftConnectors": {
          "enabled": false
        },
        "onedrivebusiness": {
          "account": "",
          "foldername": "root",
          "enabled": false,
          "folder": "root"
        }
      },
      "defaults": {
        "privacy": ""
      },
      "notifyeveryone": false,
      "filesAutoNewVersion": false,
      "defaultPrivacy": "open",
      "tasks-start-page": "default",
      "starred": false,
      "announcementHTML": "",
      "isProjectAdmin": true,
      "name": "Project One",
      "company": {
        "is-owner": "1",
        "id": "78494",
        "name": "MCG Company"
      },
      "endDate": "",
      "announcement": "",
      "show-announcement": false,
      "subStatus": "current",
      "tags": []
    }
  ]
}