Skip to content
fluidwave
Get started
API Reference

V1

V1Tasks

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

V1Lists

List lists
client.v1.lists.list(ListListParams { cursor, includeDeleted, limit, spaceId } query?, RequestOptionsoptions?): ListListResponse { data, spaceVersion, nextCursor }
GET/api/v1/lists
Create list
client.v1.lists.create(ListCreateParams { body_spaceId, listId, name } params, RequestOptionsoptions?): void
POST/api/v1/lists
Get list
client.v1.lists.retrieve(stringlistID, ListRetrieveParams { spaceId } query?, RequestOptionsoptions?): void
GET/api/v1/lists/{listId}
Update list
client.v1.lists.update(stringlistID, ListUpdateParams { spaceId } params?, RequestOptionsoptions?): void
PATCH/api/v1/lists/{listId}
Delete list (soft)
client.v1.lists.delete(stringlistID, ListDeleteParams { spaceId } params?, RequestOptionsoptions?): void
DELETE/api/v1/lists/{listId}

V1Schedules

List schedules
client.v1.schedules.list(ScheduleListParams { cursor, includeDeleted, limit, spaceId } query?, RequestOptionsoptions?): void
GET/api/v1/schedules
Create schedule
client.v1.schedules.create(ScheduleCreateParams { spaceId } params?, RequestOptionsoptions?): void
POST/api/v1/schedules
Get schedule
client.v1.schedules.retrieve(stringscheduleID, ScheduleRetrieveParams { spaceId } query?, RequestOptionsoptions?): void
GET/api/v1/schedules/{scheduleId}
Update schedule
client.v1.schedules.update(stringscheduleID, ScheduleUpdateParams { spaceId } params?, RequestOptionsoptions?): void
PATCH/api/v1/schedules/{scheduleId}
Delete schedule (soft)
client.v1.schedules.delete(stringscheduleID, ScheduleDeleteParams { spaceId } params?, RequestOptionsoptions?): void
DELETE/api/v1/schedules/{scheduleId}

V1Categories

List categories
client.v1.categories.list(CategoryListParams { cursor, includeDeleted, limit, spaceId } query?, RequestOptionsoptions?): void
GET/api/v1/categories
Create category
client.v1.categories.create(CategoryCreateParams { spaceId } params?, RequestOptionsoptions?): void
POST/api/v1/categories
Get category
client.v1.categories.retrieve(stringcategoryID, CategoryRetrieveParams { spaceId } query?, RequestOptionsoptions?): void
GET/api/v1/categories/{categoryId}
Update category
client.v1.categories.update(stringcategoryID, CategoryUpdateParams { spaceId } params?, RequestOptionsoptions?): void
PATCH/api/v1/categories/{categoryId}
Delete category (soft)
client.v1.categories.delete(stringcategoryID, CategoryDeleteParams { spaceId } params?, RequestOptionsoptions?): void
DELETE/api/v1/categories/{categoryId}

V1Contexts

List contexts
client.v1.contexts.list(ContextListParams { cursor, includeDeleted, limit, spaceId } query?, RequestOptionsoptions?): void
GET/api/v1/contexts
Create context
client.v1.contexts.create(ContextCreateParams { spaceId } params?, RequestOptionsoptions?): void
POST/api/v1/contexts
Get context
client.v1.contexts.retrieve(stringcontextID, ContextRetrieveParams { spaceId } query?, RequestOptionsoptions?): void
GET/api/v1/contexts/{contextId}
Update context
client.v1.contexts.update(stringcontextID, ContextUpdateParams { spaceId } params?, RequestOptionsoptions?): void
PATCH/api/v1/contexts/{contextId}
Delete context (soft)
client.v1.contexts.delete(stringcontextID, ContextDeleteParams { spaceId } params?, RequestOptionsoptions?): void
DELETE/api/v1/contexts/{contextId}