plnnrlydevelopers

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

UserTodo

UserTodo

A todo: one unchecked task-list line in a drive document that mentions you.

View as Markdown
Summary view
UserTodoList, 8 fields. What a list returns by default.
Detail view
UserTodo, 8 fields. The default for a single read and for every write.
Read with
api:read:project_managementandproject_management::view_backlog
Write with
api:write:project_managementandproject_management::manage_work_items

This is the list behind the Todos dashboard in plnnrly. ⚠ The collection is a derived copy of document content, not user-authored data: every write to a drive item rebuilds the whole todo set for that item from its HTML, deleting and re-creating the todos, so a todo has no stable identity across an edit of its source document and anything written through this collection is discarded on the next such edit. Completing a todo for real means unchecking-to-checking the task item in the document. The collection is hard-scoped to the authenticated caller with no escape: there is no permission, filter value or include that reads another user's todos.

Used by

GETList your todos/todosUserTodoList
POSTCreate a todo/todosUserTodo
GETRead a todo/todos/{todo}UserTodo
PATCHUpdate a todo/todos/{todo}UserTodo

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

user_idintegerServer-assigned

The user the todo belongs to. Always the authenticated caller: this collection has no way to read or write another user's todos.

drive_item_idinteger

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.

todo_contentstringMultiline

The todo line as plain text.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

userRef or UserSummary

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.

Variants

UserTodoList 8 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

UserTodoSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: user_id, drive_item_id, created_at, updated_at, user, links

UserTodoLinks 1 field

The links object on this resource.

Keys: self