Project

A project: the unit customers are billed against.

Summary view: ProjectList, 31 fields. What a list returns by default.
Detail view: Project, 33 fields. The default for a single read and for every write.
Read with: api:read:projectsandprojects::read
Write with: api:write:projectsandprojects::create

Example

detail view

{
  "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",
  "updated_at": "2026-03-04T09:15:00Z",
  "deleted_at": "2026-03-04T09:15:00Z",
  "customer_id": 1,
  "sub_customer_id": 1,
  "project_manager_id": 1,
  "account_manager_id": 1,
  "application_id": 1,
  "workflow_id": 1,
  "web_url": "…",
  "customer": {
    "id": 1
  },
  "sub_customer": null,
  "project_manager": null,
  "account_manager": null,
  "tags": {
    "data": [
      {
        "…": "2 fields of TagSummary"
      }
    ],
    "meta": {
      "truncated": false,
      "…": "1 optional field left out"
    }
  },
  "sprints_count": 1,
  "budgets_count": 1,
  "tags_count": 1,
  "tasks_count": 1,
  "logged_minutes": 1,
  "workflow_mode_options": [
    "sprints"
  ],
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "tasks": "https://<your-url>/api/v2/work-items/1",
    "budgets": "https://<your-url>/api/v2/work-items/1",
    "sprints": "https://<your-url>/api/v2/work-items/1"
  }
}

Carries a workflow mode that decides whether work is planned in sprints or on a continuous board.

Used by

GETList projects/projectsProjectList

POSTCreate a project/projectsProject

GETRead a project/projects/{project}Project

PATCHUpdate a project/projects/{project}Project

POSTRestore a deleted project/projects/{project}/actions/restoreProject

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

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.

Variants

ProjectList 31 fields

What a collection returns, and what ?view=summary returns on a single record.

Leaves out: description, workflow_mode_options

ProjectSummary 3 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: full_title, description, status, workflow_mode, start_date, end_date, is_billable, is_continuous, last_activity, created_at, updated_at, deleted_at, sub_customer_id, project_manager_id, account_manager_id, application_id, workflow_id, web_url, customer, sub_customer, project_manager, account_manager, tags, sprints_count, budgets_count, tags_count, tasks_count, logged_minutes, workflow_mode_options, links

ProjectLinks 4 fields

The links object on this resource.

Keys: self, tasks, budgets, sprints

Something wrong or missing on this page? Tell us