Read a project

GEThttps://<your-url>/api/v2/projects/{project}

MCP id projects.showAlso on this path: PATCH Update a project, DELETE Delete a project

Returns one project in the detail view, with its counts of sprints, budgets, tags and visible kanban tasks, and links to those collections.

Token scope: api:read:projects
Without it: 403 insufficient-token-scope.
Permission: projects::read
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

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

Request

Example: One project with its tags

curl -G \
  'https://<your-url>/api/v2/projects/1' \
  --data-urlencode 'include=tags' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/projects/1?include=tags', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/projects/1?include=tags');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/projects/1?include=tags',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

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"
  },
  "meta": {
    "actions": [
      "restore"
    ]
  }
}

21 more fields, listed under Response

A trashed project is 404 unless trashed=with is passed and the caller holds projects::read.

Path parameters

projectintegerRequired

The Project's numeric id. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

metaarray of string

Optional meta members to compute for this response.

actions

New values may be added.

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.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a Project in the detail view.

Headers

ETag: A strong validator of exactly this representation.
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.