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 users

GEThttps://app.aphex.co/{region}/v1/projects/{projectId}/users

Path parameters

region*enum

gb | au

gbau

projectId*string

projectId

Header parameters

Response

200401422500

OK

Body

application/json

pagingHttpPaging (object)

resultsany

resultsarray of User (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/projects/{projectId}/users', {
    method: 'GET',
    headers: {
      "X-API-Key": "text"
    },
});
const data = await response.json();

Response

200401422500

{
  "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 subcontractors

GEThttps://app.aphex.co/{region}/v1/projects/{projectId}/subcontractors

Path parameters

region*enum

gb | au

gbau

projectId*string

projectId

Header parameters

Response

200401422500

OK

Body

application/json

pagingHttpPaging (object)

resultsany

resultsarray of Subcontractor (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/projects/{projectId}/subcontractors', {
    method: 'GET',
    headers: {
      "X-API-Key": "text"
    },
});
const data = await response.json();

Response

200401422500

{
  "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 folders

GEThttps://app.aphex.co/{region}/v1/projects/{projectId}/folders

Path parameters

region*enum

gb | au

gbau

projectId*string

projectId

Header parameters

Response

200401422500

OK

Body

application/json

pagingHttpPaging (object)

resultsany

resultsarray of TaskFolder (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/projects/{projectId}/folders', {
    method: 'GET',
    headers: {
      "X-API-Key": "text"
    },
});
const data = await response.json();

Response

200401422500

{
  "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 packages

GEThttps://app.aphex.co/{region}/v1/projects/{projectId}/packages

Path parameters

region*enum

gb | au

gbau

projectId*string

projectId

Header parameters

Response

200401422500

OK

Body

application/json

pagingHttpPaging (object)

resultsany

resultsarray of TaskPackage (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/projects/{projectId}/packages', {
    method: 'GET',
    headers: {
      "X-API-Key": "text"
    },
});
const data = await response.json();

Response

200401422500

{
  "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 calendars

GEThttps://app.aphex.co/{region}/v1/projects/{projectId}/calendars

Path parameters

region*enum

gb | au

gbau

projectId*string

projectId

Header parameters

Response

200401422500

OK

Body

application/json

pagingHttpPaging (object)

resultsany

resultsarray of TaskCalendar (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/projects/{projectId}/calendars', {
    method: 'GET',
    headers: {
      "X-API-Key": "text"
    },
});
const data = await response.json();

Response

200401422500

{
  "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 locations

GEThttps://app.aphex.co/{region}/v1/projects/{projectId}/locations

Path parameters

region*enum

gb | au

gbau

projectId*string

projectId

Header parameters

Response

200401422500

OK

Body

application/json

pagingHttpPaging (object)

resultsany

resultsarray of TaskLocation (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.aphex.co/{region}/v1/projects/{projectId}/locations', {
    method: 'GET',
    headers: {
      "X-API-Key": "text"
    },
});
const data = await response.json();

Response

200401422500

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