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 users

get

Get users

Path parameters

regionanyrequired

gb | au

projectIdanyrequired

projectId

Header parameters

X-API-Keyanyrequired

access token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.aphex.co//{region}/v1/projects/{projectId}/users'

200

401

422

500

200

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

OK

Get Subcontractors

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

get subcontractors

get

Get subcontractors

Path parameters

regionanyrequired

gb | au

projectIdanyrequired

projectId

Header parameters

X-API-Keyanyrequired

access token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.aphex.co//{region}/v1/projects/{projectId}/subcontractors'

200

401

422

500

200

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

OK

Get Folders

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

get folders

get

Get folders

Path parameters

regionanyrequired

gb | au

projectIdanyrequired

projectId

Header parameters

X-API-Keyanyrequired

access token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.aphex.co//{region}/v1/projects/{projectId}/folders'

200

401

422

500

200

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

OK

Get Packages

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

get packages

get

Get packages

Path parameters

regionanyrequired

gb | au

projectIdanyrequired

projectId

Header parameters

X-API-Keyanyrequired

access token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.aphex.co//{region}/v1/projects/{projectId}/packages'

200

401

422

500

200

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

OK

Get Calendars

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

get calendars

get

Get calendars

Path parameters

regionanyrequired

gb | au

projectIdanyrequired

projectId

Header parameters

X-API-Keyanyrequired

access token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.aphex.co//{region}/v1/projects/{projectId}/calendars'

200

401

422

500

200

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

OK

Get Locations

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

get locations

get

Get locations

Path parameters

regionanyrequired

gb | au

projectIdanyrequired

projectId

Header parameters

X-API-Keyanyrequired

access token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.aphex.co//{region}/v1/projects/{projectId}/locations'

200

401

422

500

200

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

OK