API Reference

V1

Tasks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get task

client.v1.tasks.retrieve(stringtodoID, TaskRetrieveParams { spaceId } query?, RequestOptionsoptions?): SingleResponseTodo { data, spaceVersion }

GET/api/v1/tasks/{todoId}

Get task

ParametersExpand Collapse

todoID: string

query: TaskRetrieveParams { spaceId }

spaceId?: string

Optional space id; when omitted, the user’s default space is used.

ReturnsExpand Collapse

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).

Get task

TypeScript

HTTP

TypeScript

import Fluidwave from 'fluidwave';

const client = new Fluidwave();

const singleResponseTodo = await client.v1.tasks.retrieve('todoId');

console.log(singleResponseTodo.data);

200 example

{
  "data": {
    "id": "id",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "deletedAt": "2019-12-27T18:11:19.117Z",
    "isDeleted": true,
    "spaceId": "spaceId",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "versionUpdatedAt": 0,
    "sortOrder": 0,
    "todoId": "todoId",
    "complexity": "complexity",
    "contextId": "contextId",
    "dateDue": "2019-12-27T18:11:19.117Z",
    "dateStart": "2019-12-27T18:11:19.117Z",
    "durationEstimate": 0,
    "durationMs": 0,
    "goalId": "goalId",
    "isImportant": true,
    "isTimeSensitive": true,
    "listId": "listId",
    "name": "name",
    "notesMarkdown": "notesMarkdown",
    "status": "status",
    "TodoPredecessorsAllAny": "ALL",
    "TodoPredecessorsView": true
  },
  "spaceVersion": 0
}

Returns Examples

200 example

{
  "data": {
    "id": "id",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "deletedAt": "2019-12-27T18:11:19.117Z",
    "isDeleted": true,
    "spaceId": "spaceId",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "versionUpdatedAt": 0,
    "sortOrder": 0,
    "todoId": "todoId",
    "complexity": "complexity",
    "contextId": "contextId",
    "dateDue": "2019-12-27T18:11:19.117Z",
    "dateStart": "2019-12-27T18:11:19.117Z",
    "durationEstimate": 0,
    "durationMs": 0,
    "goalId": "goalId",
    "isImportant": true,
    "isTimeSensitive": true,
    "listId": "listId",
    "name": "name",
    "notesMarkdown": "notesMarkdown",
    "status": "status",
    "TodoPredecessorsAllAny": "ALL",
    "TodoPredecessorsView": true
  },
  "spaceVersion": 0
}