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
  • Overview
  • Querying the Plan APIs

Was this helpful?

  1. DEVELOPER
  2. API & Integration

Plan APIs

Last updated 11 months ago

Was this helpful?

This feature is in a closed beta phase and is available upon request only for Enterprise partners. Talk to us to learn more.

Overview

The foundation of the Aphex Planner data model are projects and tasks. Tasks reflect planned work and crucial properties such as subcontractors or shifts.

For customers and partners wanting to build external or internal applications and workflows on top of planned tasks, we provide a broad set of endpoints that give access to real-time data from a Plan workspace.

Typically use cases for these endpoints include;

  • Third-party platforms and products building integrations to Aphex

  • Internal customer teams using planned tasks as the trigger for internal apps or workflows

Querying the Plan APIs

Our APIs follow the essence of REST and all queries must be made via HTTPS to pass the endpoint security rules.

Endpoints query rules and response structure can be accessed from the following page;

Authentication

Project Assets

Tasks