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.

Last updated 11 days ago

Was this helpful?

get users

Get users

get

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

Path parameters

regionstring · enumrequired

gb | au

Options: gb, au

projectIdstringrequired

projectId

Header parameters

X-API-Keystringrequired

access token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

422

500

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

get subcontractors

Get subcontractors

get

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

Path parameters

regionstring · enumrequired

gb | au

Options: gb, au

projectIdstringrequired

projectId

Header parameters

X-API-Keystringrequired

access token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

422

500

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

get folders

Get folders

get

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

Path parameters

regionstring · enumrequired

gb | au

Options: gb, au

projectIdstringrequired

projectId

Header parameters

X-API-Keystringrequired

access token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

422

500

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

get packages

Get packages

get

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

Path parameters

regionstring · enumrequired

gb | au

Options: gb, au

projectIdstringrequired

projectId

Header parameters

X-API-Keystringrequired

access token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

422

500

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

get calendars

Get calendars

get

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

Path parameters

regionstring · enumrequired

gb | au

Options: gb, au

projectIdstringrequired

projectId

Header parameters

X-API-Keystringrequired

access token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

422

500

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

get locations

Get locations

get

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

Path parameters

regionstring · enumrequired

gb | au

Options: gb, au

projectIdstringrequired

projectId

Header parameters

X-API-Keystringrequired

access token

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

422

500

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