Skip to content
Get started

V1

V1Tasks

List tasks
GET/api/v1/tasks
Create task
POST/api/v1/tasks
Get task
GET/api/v1/tasks/{todoId}
Update task
PATCH/api/v1/tasks/{todoId}
Delete task (soft)
DELETE/api/v1/tasks/{todoId}
ModelsExpand Collapse
BaseEntity = object { id, createdAt, deletedAt, 4 more }
id: string
createdAt: string
formatdate-time
deletedAt: string
formatdate-time
isDeleted: boolean
spaceId: string
updatedAt: string
formatdate-time
versionUpdatedAt: number
SingleResponseTodo = object { data, spaceVersion }
data: Todo { sortOrder, todoId, complexity, 14 more }
sortOrder: number
todoId: string
complexity: optional string
contextId: optional string
dateDue: optional string
formatdate-time
dateStart: optional string
formatdate-time
durationEstimate: optional number
durationMs: optional number
goalId: optional string
isImportant: optional boolean
isTimeSensitive: optional boolean
listId: optional string
name: optional string
notesMarkdown: optional string
status: optional string
TodoPredecessorsAllAny: optional "ALL" or "ANY"
One of the following:
"ALL"
"ANY"
TodoPredecessorsView: optional boolean
spaceVersion: number

Current Replicache space version (Space.version).

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

V1Lists

List lists
GET/api/v1/lists
Create list
POST/api/v1/lists
Get list
GET/api/v1/lists/{listId}
Update list
PATCH/api/v1/lists/{listId}
Delete list (soft)
DELETE/api/v1/lists/{listId}

V1Schedules

List schedules
GET/api/v1/schedules
Create schedule
POST/api/v1/schedules
Get schedule
GET/api/v1/schedules/{scheduleId}
Update schedule
PATCH/api/v1/schedules/{scheduleId}
Delete schedule (soft)
DELETE/api/v1/schedules/{scheduleId}

V1Categories

List categories
GET/api/v1/categories
Create category
POST/api/v1/categories
Get category
GET/api/v1/categories/{categoryId}
Update category
PATCH/api/v1/categories/{categoryId}
Delete category (soft)
DELETE/api/v1/categories/{categoryId}

V1Contexts

List contexts
GET/api/v1/contexts
Create context
POST/api/v1/contexts
Get context
GET/api/v1/contexts/{contextId}
Update context
PATCH/api/v1/contexts/{contextId}
Delete context (soft)
DELETE/api/v1/contexts/{contextId}