List your todos
GEThttps://
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=detailmakes it 3. Adds:with_total=1+2, each include +1,q+2. - Also
If-None-Matchanswers304when 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
Pagination
Cursor pagination only. Follow links.next.
Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.
Default: 25
Filters
- =
- equals
- [in]
- any of a comma-separated list
- [gte][lt]
- at least, less than
Creation timestamp. Pair with sort=id for a stable full export.
Limit to todos parsed out of these drive items.
A comma-separated list of at most 100 values.
Last-write timestamp. Use for incremental sync.
Search
Sorting
| Key | Sorts by |
|---|---|
created_at | Newest todo first. |
id | Id, ascending. An id never changes, so use this for a stable full export. |
updated_at | Last-write timestamp; pair with the id tiebreaker for sync. |
Prefix a key with - for descending.
Includes
| Path | Adds | Cost |
|---|---|---|
user | The user the todo belongs to, always the authenticated caller. | +1 |
Request headers
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.
Response 200
Returns a page of UserTodoList rows.
The rows, each a UserTodoList.
per_page, next_cursor, prev_cursor, total.
self, next, prev.
Each row is a UserTodoList: 8 fields.
Headers
ETag- A weak validator (
W/"…") of the rendered page. RateLimit- The IETF
httpapi-ratelimit-headersform 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
The user the todo belongs to. Always the authenticated caller: this collection has no way to read or write another user's todos.
The drive item whose document this todo was parsed out of. Writable on create only; a todo cannot be re-parented. No relation object is exposed for it; read the document with GET /api/v2/drive-items/{drive_item}, which applies the drive access rules this collection does not. Archiving a drive item leaves its todos behind, so this id can name an item you can no longer read.
The user the todo belongs to, always the authenticated caller. Expanding it with ?include=user additionally requires the users::read permission and a token scope covering the users prefix.
Errors
8 errors every operation can return: 304, 400, 401, 404, 406, 429, 500, 503
304 Not modified.
400 Bad request.
idempotency-key-requiredinvalid-cursorinvalid-query-parametermalformed-requestunsupported-parameter
401 Unauthenticated.
404 Not found.
406 Not acceptable.
429 Too many requests.
500 Server error.
503 Service unavailable.
This path allows GET, POST. Anything else answers 405.
Something wrong or missing on this page? Tell us