Create a project

POSThttps://<your-url>/api/v2/projects

MCP id projects.storeAlso on this path: GET List projects

Creates a project and returns it in the detail view with a Location header.

Token scope: api:write:projects
Without it: 403 insufficient-token-scope.
Permission: projects::create
Without it: 403 insufficient-permission.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts Idempotency-Key. Never cached: private, no-store. Unknown body keys are refused, never dropped.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: A billable sprint project

curl -X POST \
  'https://<your-url>/api/v2/projects' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "title": "Portal rebuild",
    "status": "active",
    "workflow_mode": "sprints",
    "is_billable": true,
    "is_continuous": false,
    "customer_id": 1
  }'

const response = await fetch('https://<your-url>/api/v2/projects', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "title": "Portal rebuild",
    "status": "active",
    "workflow_mode": "sprints",
    "is_billable": true,
    "is_continuous": false,
    "customer_id": 1
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/projects', [
        'title' => 'Portal rebuild',
        'status' => 'active',
        'workflow_mode' => 'sprints',
        'is_billable' => true,
        'is_continuous' => false,
        'customer_id' => 1,
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/projects',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'title': 'Portal rebuild', 'status': 'active', 'workflow_mode': 'sprints', 'is_billable': True, 'is_continuous': False, 'customer_id': 1},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "title": "Portal rebuild",
    "full_title": "…",
    "description": "<p>…</p>",
    "status": "active",
    "workflow_mode": "sprints",
    "start_date": "2026-03-04",
    "end_date": "2026-03-04",
    "is_billable": true,
    "is_continuous": false,
    "last_activity": "2026-03-04T09:15:00Z",
    "created_at": "2026-03-04T09:15:00Z"
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/idempotency-key-in-flight",
  "title": "Idempotency key in flight",
  "status": 409,
  "detail": "The original request for this Idempotency-Key is still being processed. Retry shortly.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S"
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

21 more fields, listed under Response

The account manager defaults to the authenticated user and cannot be set directly. workflow_mode is required even on an organisation that does not use sprints, and the project's workflow itself is configured in plnnrly rather than here. Pass tag_ids to set the project's tags; the set is written whole.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

Idempotency-Keystring≤ 255

A caller-chosen key that makes this POST safe to retry. Replaying it returns the original response with Idempotency-Replayed: true.

Request body

Unknown keys are refused with 422, naming the key.

titlestring≤ 255Required

Project title as shown in the UI.

statusstringRequired

Lifecycle status. Setting it to invoiced finishes every task on every budget of the project.

active: Work is running.
finished: Delivered; nothing further is planned.
invoiced: Finished and billed. Setting this finishes every task on every budget of the project.
on-hold: Paused, and expected to resume.
inactive: Archived, kept for history and not worked on.

New values may be added.

workflow_modestringRequired

Whether work is planned in sprints or on a simple board.

sprints: Work is planned in sprints, with a separate backlog and an active-sprint board.
simple: A single board with workflow columns, without sprints or a backlog.

New values may be added.

is_billablebooleanRequired

Whether time on this project is billable.

is_continuousbooleanRequired

Whether the project has no planned end.

customer_idinteger → Customer.idRequired

Owning customer.

descriptionstring or null

Free-text description. HTML from the rich editor, sanitised.

start_datedate (YYYY-MM-DD) or null

First day of the project.

end_datedate (YYYY-MM-DD) or null

Last day, null if open-ended.

Must be on or after start_date.

sub_customer_idinteger or null → Customer.id

Optional sub-customer.

Response 201

Returns a Project in the detail view.

Headers

ETag: A strong validator of exactly this representation.
Idempotency-Replayed: true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
Location: The absolute URL of the created or queued resource.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

titlestring≤ 255

Project title as shown in the UI.

full_titlestring

Application name plus title. Never carries the project number, even when the organisation shows numbers in plnnrly.

descriptionhtml or nullDetail only

Free-text description. HTML from the rich editor, sanitised.

statusstring

Lifecycle status. Setting it to invoiced finishes every task on every budget of the project.

activefinishedinvoicedon-holdinactive

New values may be added.

workflow_modestring or null

Whether work is planned in sprints or on a simple board.

sprintssimple

New values may be added.

start_datedate (YYYY-MM-DD) or null

First day of the project.

end_datedate (YYYY-MM-DD) or null

Last day, null if open-ended.

is_billableboolean

Whether time on this project is billable.

is_continuousboolean

Whether the project has no planned end.

last_activitytimestamp (YYYY-MM-DDThh:mm:ssZ) or null

Most recent write anywhere in the project.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

deleted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

Soft-delete timestamp, null while live.

customer_idinteger

Owning customer.

sub_customer_idinteger or null

Optional sub-customer.

project_manager_idinteger or null

Responsible project manager.

account_manager_idinteger or nullServer-assigned

Responsible account manager. Set to the creating user and not writable.

application_idinteger or null

Linked application. Writable only while the organisation has the Infrastructure feature: sending a non-null value without it is a 422 prohibited. Null clears the link regardless.

workflow_idinteger or null

Workflow whose statuses this project's work items move through.

web_urlstring

Absolute URL that opens this project's work in plnnrly, on the organisation's own hostname. It is a stable link, safe to store: it redirects to the first of the project's backlog, all-work list or board the signed-in user may open, and to the project page when none of them applies. Read-only.

customerRef or CustomerSummary

Owning customer.

sub_customerRef or CustomerSummary or null

Optional sub-customer.

project_managerRef or UserSummary or null

Responsible project manager.

account_managerRef or UserSummary or null

Responsible account manager.

sprints_countinteger≥ 0

Number of sprints.

budgets_countinteger≥ 0

Number of budgets.

tags_countinteger≥ 0

Number of tags.

tasks_countinteger≥ 0

Number of kanban tasks on this project that the caller may see.

workflow_mode_optionsarray of stringDetail only

Workflow modes this project may switch to. Empty until a workflow is linked.

sprintssimple

New values may be added.

linksProjectLinks

Show 4 child fields

links.selfurl

The canonical URI of this record.

links.tasksurl

Kanban tasks on this project.

links.budgetsurl

Budgets on this project.

links.sprintsurl

Sprints on this project.

tagsarray of TagSummary≤ 50Only with include

Tags on this project. A project takes at most 50 tags, so the include lists them all. tag_ids replaces the whole set.

Wrapped in { data, meta }; meta.truncated says whether the cap was hit and meta.count is the full count.

Show 2 child fields

tags.idinteger

Unique identifier.

tags.titlestring≤ 255

Tag title as shown in the UI.

logged_minutesinteger or nullOn request

Sum of the worklog minutes on this project that the caller may see. Worklogs are per-user unless the caller holds times::update_others or times::delete_others. Null when the caller lacks hours::read or a token covering api:read:times.