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

document token routes #12

Merged
narthur merged 4 commits into from
Aug 27, 2025
Merged

document token routes #12

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d5b5f56
document token routes
narthur Aug 27, 2025
e845d78
expand routes in api v2 docs
narthur Aug 27, 2025
64a5118
use full delete method name
narthur Aug 27, 2025
24fcd99
document token routes
narthur Aug 27, 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
32 changes: 22 additions & 10 deletions src/api-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,16 @@ Please reach out to support@taskratchet.com to get an API key.

Base URL: <https://api.taskratchet.com/api2/>

| Endpoint | Description |
| --------------- | --------------------- |
| `GET me` | Get your profile data |
| `DEL me` | Delete your account |
| `GET me/tasks` | Get all your tasks |
| `POST me/tasks` | Create a new task |
| Endpoint | Description |
| --------------------- | ----------------------- |
| `GET /api2/me` | Get your profile data |
| `DELETE /api2/me` | Delete your account |
| `GET /api2/me/tasks` | Get all your tasks |
| `POST /api2/me/tasks` | Create a new task |
| `POST /api2/me/token` | Reset your API v2 token |
| `GET /api2/me/token` | Get your API v2 token |

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

| Response Field | Type | Description |
| ------------------- | ------- | ----------------------------------------------------- |
Expand Down Expand Up @@ -65,11 +67,11 @@ Example response:
}
```

### `DEL me`
### `DELETE /api2/me`

Deletes the user's account. This action is irreversible.

### `GET me/tasks`
### `GET /api2/me/tasks`

Returns an array of tasks. This route is paginated.

Expand Down Expand Up @@ -104,7 +106,7 @@ Example response:
]
```

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

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

Expand All @@ -130,3 +132,13 @@ Example response:
"status": "pending"
}
```

### `POST /api2/me/token`

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.

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

Returns the current API v2 token for the authenticated user.