Acuity PPM API
Projects

POST Create project

Create a new project under /api/v1/project. The source markdown documents the request headers and body fields, but does not document the exact success payload shape.

POST/project

Authorization

api-auth<api-auth>
api-token<UUID>
api-secret<api-secret>

Use the standard /api/v1 headers for this request.

The source markdown documents the request body fields in detail, so the schema below follows the Acuity UI labels and defaults.

API Credentials (save your keys here to make the request examples copy-ready)Hidden by default

Save your domain and request headers once, then reuse them across the current docs session.

Session storage clears when this tab closes. Local storage stays available the next time you open the docs in this browser.

Saved values are used in request examples and code snippets on API pages, including the request domain.

Request Body

application/json

Top-level request body type: object. Send JSON fields shown below.

portfolio*string

Required on create.

Acuity Type:string
Default:required
Acuity UI:Portfolio Name
name*string
Acuity Type:string
Default:required
Acuity UI:Name
description*string
Acuity Type:text
Default:required
Acuity UI:Description
backgroundstring
Acuity Type:text
Default:""
Acuity UI:Background
benefitsstring
Acuity Type:text
Default:""
Acuity UI:Benefits
project_objectivesstring
Acuity Type:text
Default:""
Acuity UI:Project Objectives
costinteger
Acuity Type:integer
Default:0
Acuity UI:Total Cost (Planned)
financial_benefitsinteger
Acuity Type:integer
Default:nil
Acuity UI:Financial Benefits (Planned)
hoursinteger
Acuity Type:integer
Default:0
Acuity UI:Total Project Hours
percent_completeinteger
Acuity Type:0-100
Default:0
Acuity UI:Percent Complete
Range 0..100
start_datestring
Acuity Type:date (yyyy-mm-dd)
Default:nil
Acuity UI:Start Date
Format date
end_datestring
Acuity Type:date (yyyy-mm-dd)
Default:nil
Acuity UI:Finish Date
Format date
categorystring
Acuity Type:option
Default:nil
Acuity UI:Category (or your chosen name)
departmentstring
Acuity Type:option
Default:nil
Acuity UI:Department (or your chosen name)
lifecyclestring
Acuity Type:option
Default:nil
Acuity UI:Phase (or your chosen name)
strategic_objectivestring
Acuity Type:option
Default:nil
Acuity UI:Strategic Objectives (or your chosen name)
project_sponsorstring
Acuity Type:sponsor name
Default:nil
Acuity UI:Project Sponsor (or your chosen name)
project_managerstring
Acuity Type:manager name
Default:nil
Acuity UI:Project Manager (or your chosen name)
statestring
Acuity Type:active | cancelled | completed | hold | pending
Default:active
Acuity UI:State
Value in "active" | "cancelled" | "completed" | "hold" | "pending"
prioritystring
Acuity Type:option
Default:default option
Acuity UI:Priorities (or your chosen name)
fundingstring
Acuity Type:planning | funded | unfunded
Default:nil
Acuity UI:Funding Status
Value in "planning" | "funded" | "unfunded"
financial_classstring
Acuity Type:capital | operational
Default:nil
Acuity UI:Financial Class
Value in "capital" | "operational"
team_member_1string
Acuity Type:Business Sponsor name
Default:nil
Acuity UI:Business Sponsor (or your chosen name)
team_member_2string
Acuity Type:Executive Sponsor name
Default:nil
Acuity UI:Executive Sponsor (or your chosen name)
team_member_3string
Acuity Type:IT Project Manager
Default:nil
Acuity UI:IT Project Manager (or your chosen name)
team_member_4string
Acuity Type:Product Manager
Default:nil
Acuity UI:Product Manager (or your chosen name)
custom_fieldsobject

Company-specific custom field values.

Acuity Type:Object{key:value}
Default:nil
Acuity UI:Company Custom Field
Additional properties allowed

GET Retrieve project

Previous Page

PUT Update project

Next Page