Read a todo
GEThttps://
Returns one of your todos in the detail view.
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.
- 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
The summary and detail payloads are identical on this resource: todo_content is rendered in both, because the collection is the surface this resource exists for. user renders as {"id": N} until named in include, and no relation object is exposed for the source document: read it with GET /api/v2/drive-items/{drive_item}, which applies the drive access rules this collection does not. Another user's todo answers 404, never 403. There is no soft delete: a deleted todo is gone, and trashed is not an accepted parameter.
Path parameters
Query parameters
Unknown parameters are refused with 400, naming the parameter.
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 UserTodo in the detail view.
Headers
ETag- A strong validator of exactly this representation.
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, PATCH, DELETE. Anything else answers 405.
Something wrong or missing on this page? Tell us