Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

update api v2 docs #14

Merged
narthur merged 3 commits into from
Sep 7, 2025
Merged

update api v2 docs #14

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be7c340
update api v2 docs
narthur Sep 7, 2025
7f2f613
dont call api v2 unstable
narthur Sep 7, 2025
05b667a
fix typo
narthur Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions src/api-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# API v2

::: warning
This version of the API is unstable and undergoing active development. The
This version of the API is in active development. The
API and its associated documentation are likely to be incomplete and/or incorrect,
and may change without notice.
:::
Expand Down Expand Up @@ -75,6 +75,17 @@ Deletes the user's account. This action is irreversible.

Returns an array of tasks. This route is paginated.

Query params:

| Param | Type | Required | Description |
| ---------- | ------ | -------- | ------------------------------------------------------ |
| page | number | false | Page number (default: 0) |
| status | string | false | Filter by task status (pending, complete, expired) |
| due_before | number | false | Unix timestamp; only return tasks due before this time |
| due_after | number | false | Unix timestamp; only return tasks due after this time |

Response format:

| Response Field | Type | Description |
| -------------- | ------- | ---------------------------------------------- |
| id | string | The task's unique identifier |
Expand Down Expand Up @@ -108,7 +119,7 @@ Example response:

### `POST /api2/me/tasks`

Creates a new task. The request body should be a JSON object with the following fields:\
Creates a new task. The request body should be a JSON object with the following fields:

| Field | Type | Required | Description |
| --------------- | ------ | -------- | ------------------------------------- |
Expand Down Expand Up @@ -137,7 +148,7 @@ Example response:

Reset your account's API v2 token. This will invalidate the old token and generate a new one.

You'll need to be authenticted in order to reset your token. If you don't already have a token, contact support for help.
You'll need to be authenticated in order to reset your token. If you don't already have a token, contact support for help.

### `GET /api2/me/token`

Expand Down