Aphex Help
Go to Aphex
  • Welcome
  • Getting Started
    • Joining your Team
      • Getting Around
      • Adding Tasks
      • Linking Tasks
      • Resources
      • Map & Location
      • Readying & Publishing Plans
    • Project Set Up
      • Importing
      • Folders & Structure
      • Users
      • Views
      • Resources & Assets
      • Map
      • Publishing & Routine
  • Guides
    • Imports
      • Importing your Master Schedule (XML)
      • Migrate existing plans to Aphex (CSV)
      • Importing Folders (CSV)
    • Feature Walkthroughs
      • Creating & Sharing Published Versions
      • Understanding Resources in the Plan
      • Exporting Data to a CSV
      • Copying tasks between Projects
      • Blockers
    • Integrations
      • ArcGIS Set Up Guide
      • Getting Started with Power BI Reporting
    • Reporting
      • Power BI Templates
  • Reference Docs
    • Fundamentals
      • Organisations
      • Projects
      • Tasks
      • Task Panel
      • User Preferences and Notifications
    • Scheduling
      • Views
      • Gantt
      • Board
      • List
      • Map and Clashes
      • Status and Progress Updates
    • Project Assets
      • Project Users and Teams
      • Resources and Assets
      • Structure
    • Publish, Print & Share
      • Printing
      • Published Versions and Shared Plans
      • Readying and Reviewing Plans
    • Data
      • Imports and Exports
      • Transferring
  • Frequently Asked
    • FAQs
      • How do I Add & Remove Filters?
      • How do I create & track Milestones?
      • How do I Move Folders?
      • How to login with SSO
      • Where have my Tasks gone?
      • How do I print my Plan?
      • Can I change the sort order of Tasks and Packages?
      • How is PPC calculated in the Power BI dashboard?
      • Why can't I delete a Task?
      • Why are the successors not scheduling?
      • How do I promise Tasks?
      • How do I delete multiple Tasks?
      • Why were some Tasks skipped from updating?
      • Why can't I upload an image for my Location?
      • How do I change the non-working days of a Task?
      • How do I make changes in bulk?
      • How do I transfer my work to another User?
      • How do I add new Users to the Project?
      • What can Lite users do?
      • How do I set a Reviewer?
      • How do I reset my Password?
      • How do I set up MFA?
      • Setting up SAML SSO
      • How can I use Aphex to update P6?
    • Troubleshooting
      • Troubleshooting Aphex
      • Troubleshooting your ArcGIS integrations
    • Coming Soon
      • 2025 Pricing Update
      • Changes to View Controls & Filters
      • Changes to the WBS
      • Changes with Status
  • Policies
    • Terms & Policies
      • Compliance and Certification
      • Terms & Agreements
        • Terms of Service Overview
        • Terms of Service
        • Subprocessors List
        • Service Level Agreement
      • Policies
        • Acceptable Use Policy
        • Privacy Policy
        • Cookie Policy
        • Fair Billing Policy
        • Support Policy
  • DEVELOPER
    • API & Integration
      • Plan APIs
        • Authentication
        • Project Assets
        • Tasks
      • Published Plans (Power BI) API
      • Work Area API
Powered by GitBook
On this page

Was this helpful?

  1. DEVELOPER
  2. API & Integration
  3. Plan APIs

Tasks

Last updated 6 days ago

Was this helpful?

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

Get tasks

Path parameters
regionanyRequired

gb | au

projectIdanyRequired

projectId

Query parameters
startanyOptional

YYYY-MM-DD formatted date

finishanyOptional

YYYY-MM-DD formatted date

shiftanyOptional

day | afternoon | night | 24hr

ownerIdsanyOptional

comma-delimited user IDs

folderIdsanyOptional

comma-delimited folder IDs

packageIdsanyOptional

comma-delimited package IDs

locationIdsanyOptional

comma-delimited location IDs

calendarIdsanyOptional

comma-delimited calendar IDs

subcontractorIdsanyOptional

comma-delimited subcontractor IDs

assignedToIdsanyOptional

comma-delimited user IDs

fieldsanyOptional

comma-delimited additional fields (assignees,wbs,package,parent,contractor,labourResources,plantResources,materialResources,location,workArea,progress,predecessors,successors,externalId,notes)

Header parameters
X-API-KeyanyRequired

access token

Responses
200
OK
application/json
Responseall of
401
Unauthorized
application/json
422
Unprocessable Entity
application/json
500
Internal Server Error
application/json
get
GET //{region}/v1/projects/{projectId}/tasks HTTP/1.1
Host: app.aphex.co
Accept: */*
{
  "paging": {
    "next": {
      "after": "text",
      "link": "text"
    }
  },
  "results": [
    {
      "assignedTo": [
        {
          "displayName": "text",
          "email": "text",
          "id": "text"
        }
      ],
      "calendar": {
        "id": "text",
        "name": "text",
        "type": "five-day"
      },
      "duration": 1,
      "externalId": "text",
      "finish": "text",
      "folder": {
        "code": "text",
        "id": "text",
        "name": "text",
        "parentId": "text",
        "path": "text"
      },
      "id": "text",
      "keyTask": true,
      "labour": [
        {
          "id": "text",
          "name": "text",
          "quantity": 1
        }
      ],
      "location": {
        "id": "text",
        "name": "text",
        "type": "map"
      },
      "materials": [
        {
          "dailyActual": [
            {
              "date": "text",
              "quantity": 1
            }
          ],
          "dailyPlanned": [
            {
              "date": "text",
              "quantity": 1
            }
          ],
          "id": "text",
          "name": "text",
          "quantity": 1,
          "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": 1
        }
      ],
      "progress": [
        {
          "amount": 1,
          "date": "text",
          "name": "text",
          "type": "delay"
        }
      ],
      "relatedTasks": [
        {
          "id": "text",
          "lag": 1,
          "name": "text",
          "relation": "predecessor",
          "type": "start-start"
        }
      ],
      "shift": "day",
      "start": "text",
      "status": "planned",
      "subcontractor": {
        "id": "text",
        "name": "text"
      },
      "workArea": {
        "bbox": [
          1
        ],
        "geometry": null,
        "id": null,
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "type": "text"
      }
    }
  ]
}
  • Get Tasks
  • GETget tasks