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

    Default
    active
    Allowed values
    • all
    • active
    • archived
    • current
    • late
    • completed
  • Name
    updatedAfterDate
    Type
    string
    Description

    Send back only those projects recently updated after a certain date.

    Default
    20240621
  • Name
    orderby
    Type
    string
    Description

    Order projects by a parameter

    Default
    name
    Allowed values
    • companyName
    • name
    • lastActivityDate
  • Name
    createdAfterDate
    Type
    string
    Description

    Return projects created after a certain time.

    (Format: yyyymmdd)

  • 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

    Default
    false
  • Name
    includeProjectOwner
    Type
    boolean
    Description

    The project owner can be returned by adding this parameter to the project's endpoint.

    Default
    false
  • Name
    page
    Type
    integer
    Description

    Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize.

    See How does paging work for more detailed documentation on pagination. For example: ?page=2&pageSize=10 will retrieve results 10-20.

  • Name
    pageSize
    Type
    integer
    Description

    The amount of projects returned can be limited using this parameter. Normally used in conjunction with the page parameter.

    Minimum: 1

  • Name
    orderMode
    Type
    string
    Description
    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    onlyStarredProjects
    Type
    boolean
    Description
    Default
    false
  • Name
    companyId
    Type
    string
    Description
  • Name
    projectOwnerIds
    Type
    string
    Description
  • Name
    searchTerm
    Type
    string
    Description
  • Name
    getDeleted
    Type
    boolean
    Description
    Default
    false
  • Name
    includeTags
    Type
    boolean
    Description
    Default
    false
  • 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": []
    }
  ]
}
Download Swagger