List

API Reference

Todos

List

client.todos.list(TodoListParamsquery?, RequestOptionsoptions?): Pagination<idstringcompleted_atunioncreated_atstringdescriptionuniontagsarraytitlestringupdated_atstringTodo>

get/v1/todos

Parameters

querycursorstringlimitunionTodoListParams

Hide ParametersShow Parameters

cursorstring

optional

limitunion

optional

number | null

maximum100

Returns

idstringcompleted_atunioncreated_atstringdescriptionuniontagsarraytitlestringupdated_atstringTodo

HTTPTypeScript

import TodoNinja from 'todo-ninja';

const client = new TodoNinja({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const todo of client.todos.list()) {
  console.log(todo.id);
}

200 Example

{
  "data": [
    {
      "id": "todo_nc6bzmkmd014706rfda898to",
      "completed_at": "2021-01-01T00:00:00.000Z",
      "created_at": "2021-01-01T00:00:00.000Z",
      "description": "Get butter, milk, and bread",
      "tags": [
        {
          "id": "tag_tz4a98xxat96iws9zmbrgj3a",
          "created_at": "2021-01-01T00:00:00.000Z",
          "label": "Work",
          "updated_at": "2021-01-01T00:00:00.000Z"
        }
      ],
      "title": "Buy groceries",
      "updated_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}