Acuity PPM API

Getting Started

Authentication and request basics for the Acuity PPM API.

Base URL

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

Current project endpoints use two base path patterns:

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

Authentication

The current project endpoints use two authentication patterns:

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

Current examples

The current documentation includes examples for: