Tasks

Project Tasks are the core object of Aphex Plan - this endpoint will return realtime Task data for a provided query.

Get Tasks

Use this endpoint to query Tasks on a project.

get tasks

Get tasks

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

Path parameters

region*enum

gb | au

gbau

projectId*string

projectId

Query parameters

Header parameters

Response

200401422500

OK

Body

application/json

pagingHttpPaging (object)

resultsany

resultsarray of Task (object)

Request

JavaScriptCurlPython

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

Response

200401422500

{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "assignedTo": [
        {
          "displayName": "text",
          "email": "text",
          "id": "text"
        }
      ],
      "calendar": {
        "id": "text",
        "name": "text",
        "type": "five-day"
      },
      "externalId": "text",
      "finish": "text",
      "folder": {
        "code": "text",
        "id": "text",
        "name": "text",
        "parentId": "text",
        "path": "text"
      },
      "id": "text",
      "keyTask": false,
      "labour": [
        {
          "id": "text",
          "name": "text",
          "quantity": 0
        }
      ],
      "location": {
        "id": "text",
        "name": "text",
        "type": "map"
      },
      "materials": [
        {
          "dailyActual": [
            {
              "date": "text",
              "quantity": 0
            }
          ],
          "dailyPlanned": [
            {
              "date": "text",
              "quantity": 0
            }
          ],
          "id": "text",
          "name": "text",
          "quantity": 0,
          "unit": "text"
        }
      ],
      "name": "text",
      "notes": "text",
      "owner": {
        "displayName": "text",
        "email": "text",
        "id": "text"
      },
      "package": {
        "code": "text",
        "id": "text",
        "name": "text"
      },
      "parent": {
        "id": "text",
        "name": "text"
      },
      "plant": [
        {
          "category": "text",
          "id": "text",
          "name": "text",
          "quantity": 0
        }
      ],
      "progress": [
        {
          "date": "text",
          "name": "text",
          "type": "delay"
        }
      ],
      "relatedTasks": [
        {
          "id": "text",
          "name": "text",
          "relation": "predecessor",
          "type": "start-start"
        }
      ],
      "shift": "day",
      "start": "text",
      "status": "planned",
      "subcontractor": {
        "id": "text",
        "name": "text"
      },
      "workArea": {
        "bbox": [
          0
        ],
        "type": "text"
      }
    }
  ]
}