Getting Started

Base URL

Examples in this documentation use a <domain> placeholder because Acuity PPM can be deployed in different environments.

Project and proposal endpoints use two base path patterns:

• /api/snapshot/...
• /api/v1/...

For Power BI and other reporting integrations, use /api/bi/odata/v1 or /api/bi/v1/... on your Acuity environment's host. Start with the Power BI setup guide.

Authentication

The current project and proposal endpoints use two authentication patterns:

• GET /projects uses the Company-Api-Token header with /api/snapshot/projects.
• GET /proposals uses the Company-Api-Token header with /api/snapshot/proposals.
• GET /project, POST /project, and PUT /project use api-auth, api-token, and api-secret with /api/v1/....
• GET /proposal, POST /proposal, and PUT /proposal use api-auth, api-token, and api-secret with /api/v1/....
• GET /project also requires a record-token header with the target project_token.
• GET /proposal also requires a record-token header with the target project_token.

BI reporting uses the company API token with Basic authentication, the Company-Api-Token header, or the supported query parameter. It requires enabled company reporting. See BI authentication for the reporting-specific contract.

Current examples

The current documentation includes examples for:

• GET List projects
• GET Retrieve project
• POST Create project
• PUT Update project
• GET List proposals
• GET Retrieve proposal
• POST Create proposal
• PUT Update proposal