Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

GET/projects/{project}/tasks

List a project's tasks

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

MCP id projects.tasks.indexAlso on this path: POST Create a task on a project

View as Markdown openapi.json

Returns the kanban tasks on one project, lowest board position first.

Access

Token scope
api:read:kanban

Without it: 403 insufficient-token-scope.

Permission
kanban::manage_self

Without it: 403 insufficient-permission.

Rate cost
1 unit, read bucket. view=detail makes it 3. Adds: with_total=1 +2, q +2.
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

There is no organisation-wide collection of tasks (a kanban board is per-user), so this nested path is the only way to list them, and filter[project_id] / filter[customer_id] do not exist: the project is the path segment. Tasks are per-user, so filter[user_id] defaults to the authenticated user and naming another user requires kanban::manage_for_others; without that permission you also do not see the cards left unassigned in plnnrly. Listing additionally requires projects::read on the parent project: the declared kanban::manage_self is only part of the requirement. A trashed project answers 404 unless trashed=with is passed. The summary and detail views are identical on this resource.

Path parameters

projectintegerRequired

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

Query parameters

Unknown parameters are refused with 400, naming the parameter.

30 parameters in 6 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

Cursor pagination only. Follow links.next.

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

with_totalboolean

Whether meta.page.total is counted for this request.

Default: false

Filters

=
equals
[in]
any of a comma-separated list
[null]
true or false: whether it is empty
[gte][lte][lt]
at least, at most, less than
[ne]
not equal
filter[budget_id]integer=[in]

Budget the task is filed under. Combine with the project in the path to narrow a board to one budget.

A comma-separated list of at most 100 values.

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[due_date]date (YYYY-MM-DD)=[gte][lte][null]

Day the task is due. null reaches the cards left undated in plnnrly.

Whether the field is null.

filter[is_billable]boolean

Whether time logged on this task is billable.

filter[is_finished]boolean

Whether the task is done. Kept in step with status automatically, so filter[is_finished]=true and filter[status]=finished select the same rows.

filter[status]string=[ne][in]

Kanban column the card sits in.

A comma-separated list of at most 100 values.

on-holdnewactiveinternal-testexternal-testfinished

New values may be added.

filter[team_id]integer=[in][null]

Team the task is filed under. Only plnnrly itself assigns one, so tasks created through the API always match filter[team_id][null]=true.

A comma-separated list of at most 100 values.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

filter[user_id]integer=[in][null]

Whose board to return. Accepts the literal me, and defaults to the authenticated user; naming another user requires kanban::manage_for_others.

A comma-separated list of at most 100 values.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: order_column

KeySorts by
order_columnPosition on the kanban board, lowest first. Server-assigned and changed when someone drags the card in plnnrly; ties are broken by id.
due_dateDay the task is due.
idId, ascending. An id never changes, so use this for a stable full export.
updated_atLast-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Other

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

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 page of TaskList rows.

dataarray of TaskList

The rows, each a TaskList.

per_page, next_cursor, prev_cursor, total.

Each row is a TaskList: 17 fields.

Headers

ETag
A weak validator (W/"…") of the rendered page.
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

Errors

8 errors every operation can return: 304, 400, 401, 404, 406, 429, 500, 503

This path allows GET, POST. Anything else answers 405.