Acuity PPM API

Tokens and authentication

Where do I get `Company-Api-Token`?

Ask Acuity Support for your company token, or find it in:

Project -> Information -> Gear -> Company Api Token

What is the difference between `Company-Api-Token` and `api-token`?

In the current documentation UI, they are treated as the same saved value because they represent the same company-level token in the examples we support today.

What are `api-auth` and `api-secret` used for?

They are required for /api/v1/... endpoints such as:

GET /project
POST /project
PUT /project
GET /proposal
POST /proposal
PUT /proposal

For project and proposal create/update requests, put values in custom_fields using the field display name. A field configured as numeric accepts a decimal string with an optional + or - sign and up to two decimal places. Both . and , are accepted as decimal separators.

{
  "custom_fields": {
    "Custom Numeric Field": "123,45"
  }
}

Whole-number strings such as "123" are also valid. Thousands separators, scientific notation, surrounding whitespace, empty strings, and more than two decimal places are rejected with HTTP 400. For example, "1,234.56" and "123.456" are invalid.

In project/proposal detail and snapshot responses, the field appears as a top-level display-name key, with a decimal string using a dot:

{
  "Custom Numeric Field": "123.45"
}

A saved numeric field with no value is returned as an empty string. A company field without a saved value record may be returned as null. Fixed trailing zeros are not guaranteed; "123.00" can be returned as "123.0".

Records and identifiers

What is `record-token`?

record-token is the target record identifier used by endpoints such as GET /project and GET /proposal.

For project and proposal retrieval, this value is usually the project_token returned by a list endpoint.

What is `record-id`?

record-id is the numeric record identifier used by some endpoints such as GET /project/task.

For task retrieval, record-id maps to the task id.

Domains and environments

Why do the examples use `https://domain/...`?

Acuity PPM can be deployed in different customer or regional environments. The docs use domain as a placeholder so the examples are not tied to a single host.

Why does an endpoint exist in GitHub docs but not in my environment?

Some routes may be available only in specific environments, feature sets, or application versions. When live behavior differs from the markdown source, the docs are aligned to the currently verified API behavior.

FAQ