Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.
Merged
Changes from all commits
Commits
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
19 changes: 17 additions & 2 deletions src/api-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,16 @@ and may change without notice.

## Authentication

Please reach out to support@taskratchet.com to get an API key and instructions on
how to provide it in your request headers.
To use the TaskRatchet API, you need an API key. This key is used to authenticate your requests and is required for all endpoints.

Example request with API key:

```bash
curl "https://api.taskratchet.com/api2/me" \
-H "Authorization: ApiKey-v2 YOUR_API_V2_TOKEN"
```

Please reach out to support@taskratchet.com to get an API key.

## Schema

Expand Down Expand Up @@ -68,6 +76,13 @@ Returns an array of tasks. This route is paginated.
| complete | boolean | Whether the task is complete |
| status | string | The task's status (pending, complete, expired) |

Example request:

```bash
curl "https://api.taskratchet.com/api2/me/tasks?page=0" \
-H "Authorization: ApiKey-v2 YOUR_API_V2_TOKEN"
```

Example response:

```json
Expand Down