Skip to content
Get started

Tasks

List tasks
client.v1.tasks.list(TaskListParams { contextId, cursor, includeDeleted, 4 more } query?, RequestOptionsoptions?): TaskListResponse { data, spaceVersion, nextCursor }
GET/api/v1/tasks
Create task
client.v1.tasks.create(TaskCreateParams { body_spaceId, categoryIds, contextId, 6 more } params, RequestOptionsoptions?): SingleResponseTodo { data, spaceVersion }
POST/api/v1/tasks
Get task
client.v1.tasks.retrieve(stringtodoID, TaskRetrieveParams { spaceId } query?, RequestOptionsoptions?): SingleResponseTodo { data, spaceVersion }
GET/api/v1/tasks/{todoId}
Update task
client.v1.tasks.update(stringtodoID, TaskUpdateParams { body_spaceId } params, RequestOptionsoptions?): SingleResponseTodo { data, spaceVersion }
PATCH/api/v1/tasks/{todoId}
Delete task (soft)
client.v1.tasks.delete(stringtodoID, TaskDeleteParams { spaceId } params?, RequestOptionsoptions?): SingleResponseTodo { data, spaceVersion }
DELETE/api/v1/tasks/{todoId}
ModelsExpand Collapse
BaseEntity { id, createdAt, deletedAt, 4 more }
id: string
createdAt: string
formatdate-time
deletedAt: string | null
formatdate-time
isDeleted: boolean
spaceId: string
updatedAt: string
formatdate-time
versionUpdatedAt: number
SingleResponseTodo { data, spaceVersion }
data: Todo { sortOrder, todoId, complexity, 14 more }
sortOrder: number
todoId: string
complexity?: string | null
contextId?: string | null
dateDue?: string | null
formatdate-time
dateStart?: string | null
formatdate-time
durationEstimate?: number | null
durationMs?: number | null
goalId?: string | null
isImportant?: boolean
isTimeSensitive?: boolean
listId?: string | null
name?: string | null
notesMarkdown?: string | null
status?: string | null
TodoPredecessorsAllAny?: "ALL" | "ANY"
One of the following:
"ALL"
"ANY"
TodoPredecessorsView?: boolean
spaceVersion: number

Current Replicache space version (Space.version).

Todo extends BaseEntity { id, createdAt, deletedAt, 4 more } { sortOrder, todoId, complexity, 14 more }
sortOrder: number
todoId: string
complexity?: string | null
contextId?: string | null
dateDue?: string | null
formatdate-time
dateStart?: string | null
formatdate-time
durationEstimate?: number | null
durationMs?: number | null
goalId?: string | null
isImportant?: boolean
isTimeSensitive?: boolean
listId?: string | null
name?: string | null
notesMarkdown?: string | null
status?: string | null
TodoPredecessorsAllAny?: "ALL" | "ANY"
One of the following:
"ALL"
"ANY"
TodoPredecessorsView?: boolean