Go to Aphex

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
200
OK
application/json
Responseall of
get
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

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
200
OK
application/json
Responseall of
get
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

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
200
OK
application/json
Responseall of
get
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

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
200
OK
application/json
Responseall of
get
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

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
200
OK
application/json
Responseall of
get
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

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
200
OK
application/json
Responseall of
get
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"
    }
  ]
}

Last updated

Was this helpful?