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/todos

List your todos

GEThttps://<your-url>/api/v2/todos

MCP id todos.indexAlso on this path: POST Create a todo

View as Markdown openapi.json

Returns your todos (the unchecked task-list lines in drive documents that mention you), newest first.

Access

Token scope
api:read:project_management

Without it: 403 insufficient-token-scope.

Permission
project_management::view_backlog

Without it: 403 insufficient-permission.

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

This is the list behind the Todos dashboard in plnnrly. The collection is hard-scoped to the authenticated caller with no escape: there is no permission that widens it, filter[user_id] accepts me and nothing else, and no include reaches another user's rows. ⚠ Rows are auto-derived from document content: every write to a drive item deletes the whole todo set for that item and rebuilds it from the document HTML, so ids are not stable across an edit of a source document. ?q= substring-matches todo_content, and filter[drive_item_id] narrows to particular documents. total is omitted unless you pass with_total=1.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

17 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
[gte][lt]
at least, less than
filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

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

filter[drive_item_id]integer=[in]

Limit to todos parsed out of these drive items.

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]

Whose todos to return. Accepts the literal me, and me is the only value any caller may name: this collection has no permission that grants access to another user's todos.

A comma-separated list of at most 100 values.

Sorting

sortstring

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

Default: created_at

KeySorts by
created_atNewest todo first.
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.

Includes

includestring

Comma-separated names to inline, at most five.

PathAddsCost
userThe user the todo belongs to, always the authenticated caller.+1

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 UserTodoList rows.

dataarray of UserTodoList

The rows, each a UserTodoList.

per_page, next_cursor, prev_cursor, total.

Each row is a UserTodoList: 8 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.