Introduction

This PQFORCE API description is intended for readers with a technical background who are involved in integrating third-party systems with PQFORCE. Rather than serving as a complete reference of every endpoint and parameter, this document acts as an entry point into the API and its underlying concepts. It introduces the general structure, guiding principles, and core logic of the interface, and highlights the most important aspects that are required to design, implement, and maintain reliable integrations. The goal is to enable developers, system architects, and integration specialists to quickly gain an understanding of how PQFORCE exposes its data and functionality through a REST-based interface.

Purpose of the API

The PQFORCE API serves as the primary interface between the project and portfolio management software PQFORCE and external third-party systems. While it has been primarily developed to support the PQFORCE client running in the user’s web browser, the API is not limited to this use case. It also enables automated, system-to-system communication with any external application that can consume REST APIs over HTTP. Through this interface, structured data can be both read from and written to PQFORCE, allowing external systems to interact with projects, resources, time data, costs, and other core entities in a controlled and standardized way.

Common Use Cases

Typical use cases for automated data exchange via the PQFORCE API include importing master or transactional data from ERP systems, synchronizing reported working times or planned absences with workforce or scheduling tools, and exporting consolidated time, cost, or portfolio planning data to reporting or business intelligence platforms. In most scenarios, the data exchange is orchestrated by an external software component. At INTRASOFT, we commonly refer to this component as the Agent. The Agent runs within the customer’s own IT ecosystem and is responsible for handling authentication, triggering data transfers, and mapping data structures between systems. These transfers are usually initiated based on predefined triggers, such as scheduled time intervals or specific business events, ensuring that data remains consistent and up to date across all connected systems. 

Documentation

The documentation for the most recent API version is available in the customer portal under Downloads → System Documentation (login required, click here), where it can be accessed as a PDF. In addition, the complete PQFORCE API specification - provided in accordance with the OpenAPI standard - can be retrieved directly via the following endpoints:

GET /API/V2/MAIN/ApiDescription/OpenApi/303/Json

GET /API/V2/MAIN/ApiDescription/OpenApi/303/Yaml

These endpoints expose the full, machine-readable API definition and can be used to generate client libraries, validate requests, or explore the available endpoints and data models programmatically.