1 of 1

Project Assets

Project assets are the defined lists of objects that can be attached to tasks within a project. You can query these assets to assist in constructing more precise Task queries.

Get Users

Use this endpoint to query the list of Users on a project.

Get Subcontractors

Use this endpoint to query the list of Subcontractors on a project.

Get Folders

Use this endpoint to query the tree of Folders on a project.

Get Packages

Use this endpoint to query the list of Packages on a project.

Get Calendars

Use this endpoint to query the list of Calendars on a project.

Get Locations

Use this endpoint to query the list of Locations on a project.

Project Assets

Project assets are the defined lists of objects that can be attached to tasks within a project. You can query these assets to assist in constructing more precise Task queries.

Get Users

Use this endpoint to query the list of Users on a project.

Get Subcontractors

Use this endpoint to query the list of Subcontractors on a project.

Get Folders

Use this endpoint to query the tree of Folders on a project.

Get Packages

Use this endpoint to query the list of Packages on a project.

Get Calendars

Use this endpoint to query the list of Calendars on a project.

Get Locations

Use this endpoint to query the list of Locations on a project.

get users

get

Get users

Path parameters

regionanyRequired

gb | au

projectIdanyRequired

projectId

Header parameters

X-API-KeyanyRequired

access token

Responses

200

application/json

afterstringOptional

linkstringOptional

displayNamestringOptional

emailstringOptional

idstringOptional

401

Unauthorized

application/json

messageanyOptional

422

Unprocessable Entity

application/json

messageanyOptional

500

Internal Server Error

application/json

messageanyOptional

get/{region}/v1/projects/{projectId}/users

GET /{region}/v1/projects/{projectId}/users HTTP/1.1
Host: app.aphex.co/
Accept: */*

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "displayName": "text",
      "email": "text",
      "id": "text"
    }
  ]
}

get subcontractors

get

Get subcontractors

Path parameters

regionanyRequired

gb | au

projectIdanyRequired

projectId

Header parameters

X-API-KeyanyRequired

access token

Responses

200

application/json

afterstringOptional

linkstringOptional

idstringOptional

namestringOptional

401

Unauthorized

application/json

messageanyOptional

422

Unprocessable Entity

application/json

messageanyOptional

500

Internal Server Error

application/json

messageanyOptional

get/{region}/v1/projects/{projectId}/subcontractors

GET /{region}/v1/projects/{projectId}/subcontractors HTTP/1.1
Host: app.aphex.co/
Accept: */*

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

get folders

get

Get folders

Path parameters

regionanyRequired

gb | au

projectIdanyRequired

projectId

Header parameters

X-API-KeyanyRequired

access token

Responses

200

application/json

afterstringOptional

linkstringOptional

codestringOptional

idstringOptional

namestringOptional

parentIdstringOptional

pathstringOptional

401

Unauthorized

application/json

messageanyOptional

422

Unprocessable Entity

application/json

messageanyOptional

500

Internal Server Error

application/json

messageanyOptional

get/{region}/v1/projects/{projectId}/folders

GET /{region}/v1/projects/{projectId}/folders HTTP/1.1
Host: app.aphex.co/
Accept: */*

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "code": "text",
      "id": "text",
      "name": "text",
      "parentId": "text",
      "path": "text"
    }
  ]
}

get packages

get

Get packages

Path parameters

regionanyRequired

gb | au

projectIdanyRequired

projectId

Header parameters

X-API-KeyanyRequired

access token

Responses

200

application/json

afterstringOptional

linkstringOptional

codestringOptional

idstringOptional

namestringOptional

401

Unauthorized

application/json

messageanyOptional

422

Unprocessable Entity

application/json

messageanyOptional

500

Internal Server Error

application/json

messageanyOptional

get/{region}/v1/projects/{projectId}/packages

GET /{region}/v1/projects/{projectId}/packages HTTP/1.1
Host: app.aphex.co/
Accept: */*

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "code": "text",
      "id": "text",
      "name": "text"
    }
  ]
}

get calendars

get

Get calendars

Path parameters

regionanyRequired

gb | au

projectIdanyRequired

projectId

Header parameters

X-API-KeyanyRequired

access token

Responses

200

application/json

afterstringOptional

linkstringOptional

idstringOptional

namestringOptional

typestring · enumOptionalPossible values:

401

Unauthorized

application/json

messageanyOptional

422

Unprocessable Entity

application/json

messageanyOptional

500

Internal Server Error

application/json

messageanyOptional

get/{region}/v1/projects/{projectId}/calendars

GET /{region}/v1/projects/{projectId}/calendars HTTP/1.1
Host: app.aphex.co/
Accept: */*

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "id": "text",
      "name": "text",
      "type": "five-day"
    }
  ]
}

get locations

get

Get locations

Path parameters

regionanyRequired

gb | au

projectIdanyRequired

projectId

Header parameters

X-API-KeyanyRequired

access token

Responses

200

application/json

afterstringOptional

linkstringOptional

idstringOptional

namestringOptional

typestring · enumOptionalPossible values:

401

Unauthorized

application/json

messageanyOptional

422

Unprocessable Entity

application/json

messageanyOptional

500

Internal Server Error

application/json

messageanyOptional

get/{region}/v1/projects/{projectId}/locations

GET /{region}/v1/projects/{projectId}/locations HTTP/1.1
Host: app.aphex.co/
Accept: */*

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "id": "text",
      "name": "text",
      "type": "map"
    }
  ]
}