# 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

```json
{"openapi":"3.1.1","info":{"title":"Plan API","version":"1.3.5"},"servers":[{"url":"https://app.aphex.co/"}],"paths":{"/{region}/v1/projects/{projectId}/users":{"get":{"description":"Get users","summary":"get users","parameters":[{"enum":["gb","au"],"type":"string","description":"gb | au","name":"region","in":"path","required":true},{"type":"string","description":"projectId","name":"projectId","in":"path","required":true},{"type":"string","description":"access token","name":"X-API-Key","in":"header","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HttpResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}}}}}},"components":{"schemas":{"HttpResponse":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/HttpPaging"},"results":{}}},"HttpPaging":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/HttpPage"}}},"HttpPage":{"type":"object","properties":{"after":{"type":"string"},"link":{"type":"string"}}},"User":{"type":"object","properties":{"displayName":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"}}},"echo.HTTPError":{"type":"object","properties":{"message":{}}}}}}
```

## Get Subcontractors

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

## get subcontractors

> Get subcontractors

```json
{"openapi":"3.1.1","info":{"title":"Plan API","version":"1.3.5"},"servers":[{"url":"https://app.aphex.co/"}],"paths":{"/{region}/v1/projects/{projectId}/subcontractors":{"get":{"description":"Get subcontractors","summary":"get subcontractors","parameters":[{"enum":["gb","au"],"type":"string","description":"gb | au","name":"region","in":"path","required":true},{"type":"string","description":"projectId","name":"projectId","in":"path","required":true},{"type":"string","description":"access token","name":"X-API-Key","in":"header","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HttpResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Subcontractor"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}}}}}},"components":{"schemas":{"HttpResponse":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/HttpPaging"},"results":{}}},"HttpPaging":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/HttpPage"}}},"HttpPage":{"type":"object","properties":{"after":{"type":"string"},"link":{"type":"string"}}},"Subcontractor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"echo.HTTPError":{"type":"object","properties":{"message":{}}}}}}
```

## Get Folders

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

## get folders

> Get folders

```json
{"openapi":"3.1.1","info":{"title":"Plan API","version":"1.3.5"},"servers":[{"url":"https://app.aphex.co/"}],"paths":{"/{region}/v1/projects/{projectId}/folders":{"get":{"description":"Get folders","summary":"get folders","parameters":[{"enum":["gb","au"],"type":"string","description":"gb | au","name":"region","in":"path","required":true},{"type":"string","description":"projectId","name":"projectId","in":"path","required":true},{"type":"string","description":"access token","name":"X-API-Key","in":"header","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HttpResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/TaskFolder"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}}}}}},"components":{"schemas":{"HttpResponse":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/HttpPaging"},"results":{}}},"HttpPaging":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/HttpPage"}}},"HttpPage":{"type":"object","properties":{"after":{"type":"string"},"link":{"type":"string"}}},"TaskFolder":{"type":"object","properties":{"code":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"parentId":{"type":"string"},"path":{"type":"string"}}},"echo.HTTPError":{"type":"object","properties":{"message":{}}}}}}
```

## Get Packages

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

## get packages

> Get packages

```json
{"openapi":"3.1.1","info":{"title":"Plan API","version":"1.3.5"},"servers":[{"url":"https://app.aphex.co/"}],"paths":{"/{region}/v1/projects/{projectId}/packages":{"get":{"description":"Get packages","summary":"get packages","parameters":[{"enum":["gb","au"],"type":"string","description":"gb | au","name":"region","in":"path","required":true},{"type":"string","description":"projectId","name":"projectId","in":"path","required":true},{"type":"string","description":"access token","name":"X-API-Key","in":"header","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HttpResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/TaskPackage"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}}}}}},"components":{"schemas":{"HttpResponse":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/HttpPaging"},"results":{}}},"HttpPaging":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/HttpPage"}}},"HttpPage":{"type":"object","properties":{"after":{"type":"string"},"link":{"type":"string"}}},"TaskPackage":{"type":"object","properties":{"code":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"echo.HTTPError":{"type":"object","properties":{"message":{}}}}}}
```

## Get Calendars

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

## get calendars

> Get calendars

```json
{"openapi":"3.1.1","info":{"title":"Plan API","version":"1.3.5"},"servers":[{"url":"https://app.aphex.co/"}],"paths":{"/{region}/v1/projects/{projectId}/calendars":{"get":{"description":"Get calendars","summary":"get calendars","parameters":[{"enum":["gb","au"],"type":"string","description":"gb | au","name":"region","in":"path","required":true},{"type":"string","description":"projectId","name":"projectId","in":"path","required":true},{"type":"string","description":"access token","name":"X-API-Key","in":"header","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HttpResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/TaskCalendar"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}}}}}},"components":{"schemas":{"HttpResponse":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/HttpPaging"},"results":{}}},"HttpPaging":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/HttpPage"}}},"HttpPage":{"type":"object","properties":{"after":{"type":"string"},"link":{"type":"string"}}},"TaskCalendar":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["five-day","six-day","seven-day","two-day","custom"]}}},"echo.HTTPError":{"type":"object","properties":{"message":{}}}}}}
```

## Get Locations

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

## get locations

> Get locations

```json
{"openapi":"3.1.1","info":{"title":"Plan API","version":"1.3.5"},"servers":[{"url":"https://app.aphex.co/"}],"paths":{"/{region}/v1/projects/{projectId}/locations":{"get":{"description":"Get locations","summary":"get locations","parameters":[{"enum":["gb","au"],"type":"string","description":"gb | au","name":"region","in":"path","required":true},{"type":"string","description":"projectId","name":"projectId","in":"path","required":true},{"type":"string","description":"access token","name":"X-API-Key","in":"header","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HttpResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/TaskLocation"}}}}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/echo.HTTPError"}}}}}}}},"components":{"schemas":{"HttpResponse":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/HttpPaging"},"results":{}}},"HttpPaging":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/HttpPage"}}},"HttpPage":{"type":"object","properties":{"after":{"type":"string"},"link":{"type":"string"}}},"TaskLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["map","drawing","off-site"]}}},"echo.HTTPError":{"type":"object","properties":{"message":{}}}}}}
```