> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getkato.io/llms.txt
> Use this file to discover all available pages before exploring further.

# All endpoints

> The complete developer, CLI, Raycast, and OAuth endpoint directory.

This index covers every operation on Kato's developer, CLI, Raycast, and OAuth integration surfaces: **49 canonical operations**, plus **four compatibility aliases**. All paths below use `https://api.getkato.io`.

Choose the surface before choosing an endpoint. Developer keys, Raycast OAuth tokens, and signed-in sessions have different access rules. Internal application routes, provider callbacks, and service-to-service endpoints are not supported developer integration contracts and are not included here.

Examples throughout the reference use illustrative IDs and workspace data. Replace them with values returned by your workspace.

## Developer API

Workspace-scoped developer keys. See [authentication](/api-reference/authentication).

| Method | Path                              | Reference                                                            | Required scopes  |
| ------ | --------------------------------- | -------------------------------------------------------------------- | ---------------- |
| GET    | `/v1/whoami`                      | [Inspect your access key](/api-reference/whoami)                     | Valid credential |
| GET    | `/v1/objects`                     | [List objects](/api-reference/objects/list)                          | `objects:read`   |
| GET    | `/v1/objects/{object}/fields`     | [List object fields](/api-reference/objects/fields)                  | `objects:read`   |
| GET    | `/v1/records`                     | [List records](/api-reference/records/list)                          | `records:read`   |
| POST   | `/v1/records`                     | [Create a record](/api-reference/records/create)                     | `records:write`  |
| GET    | `/v1/records/{recordId}`          | [Get a record](/api-reference/records/get)                           | `records:read`   |
| PATCH  | `/v1/records/{recordId}`          | [Update a record](/api-reference/records/update)                     | `records:write`  |
| PUT    | `/v1/records/{recordId}`          | [Upsert a record](/api-reference/records/upsert)                     | `records:write`  |
| DELETE | `/v1/records/{recordId}`          | [Archive a record](/api-reference/records/archive)                   | `records:write`  |
| POST   | `/v1/records/{recordId}/restore`  | [Restore a record](/api-reference/records/restore)                   | `records:write`  |
| POST   | `/v1/records/{recordId}/comments` | [Add a record comment](/api-reference/records/comments-create)       | `comments:write` |
| GET    | `/v1/tasks`                       | [List tasks](/api-reference/tasks/list)                              | `tasks:read`     |
| POST   | `/v1/tasks`                       | [Create a task](/api-reference/tasks/create)                         | `tasks:write`    |
| GET    | `/v1/tasks/{taskId}`              | [Get a task](/api-reference/tasks/get)                               | `tasks:read`     |
| PATCH  | `/v1/tasks/{taskId}`              | [Update a task](/api-reference/tasks/update)                         | `tasks:write`    |
| DELETE | `/v1/tasks/{taskId}`              | [Archive a task](/api-reference/tasks/archive)                       | `tasks:write`    |
| GET    | `/v1/webhooks`                    | [List webhook endpoints](/api-reference/webhooks/list)               | `webhooks:read`  |
| GET    | `/v1/webhooks/events`             | [List supported webhook events](/api-reference/webhooks/list-events) | `webhooks:read`  |
| POST   | `/v1/webhooks`                    | [Create a webhook endpoint](/api-reference/webhooks/create)          | `webhooks:write` |
| DELETE | `/v1/webhooks/{endpointId}`       | [Delete a webhook endpoint](/api-reference/webhooks/delete)          | `webhooks:write` |

## CLI API

Developer keys; environment operations also require a current owner or admin role. See [CLI conventions](/api-reference/cli/overview).

| Method | Path                       | Reference                                                    | Required scopes  |
| ------ | -------------------------- | ------------------------------------------------------------ | ---------------- |
| GET    | `/cli/v1/whoami`           | [Inspect CLI credentials](/api-reference/cli/whoami)         | Valid credential |
| GET    | `/cli/v1/projects`         | [List CLI projects](/api-reference/cli/projects)             | Valid credential |
| GET    | `/cli/v1/env/environments` | [List project environments](/api-reference/cli/environments) | `env:read`       |
| GET    | `/cli/v1/env/pull`         | [Pull environment variables](/api-reference/cli/pull)        | `env:read`       |
| POST   | `/cli/v1/env/push`         | [Push environment variables](/api-reference/cli/push)        | `env:write`      |

## Raycast API

OAuth access tokens issued to `kato-raycast`. Every listed scope is required. See [Raycast conventions](/api-reference/raycast/overview).

| Method | Path                                                    | Reference                                                                    | Required scopes                                     |
| ------ | ------------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------- |
| GET    | `/v1/raycast/whoami`                                    | [Inspect Raycast identity](/api-reference/raycast/whoami)                    | Valid credential                                    |
| GET    | `/v1/raycast/task-statuses`                             | [List Raycast task statuses](/api-reference/raycast/task-statuses)           | `tasks:read`                                        |
| GET    | `/v1/raycast/task-options`                              | [Get task creation options](/api-reference/raycast/task-options)             | `tasks:write`, `records:read`, `meetings:read`      |
| GET    | `/v1/raycast/tasks`                                     | [List my Raycast tasks](/api-reference/raycast/tasks-list)                   | `tasks:read`                                        |
| POST   | `/v1/raycast/tasks`                                     | [Create a Raycast task](/api-reference/raycast/tasks-create)                 | `tasks:write`                                       |
| GET    | `/v1/raycast/tasks/{taskId}`                            | [Get Raycast task details](/api-reference/raycast/tasks-get)                 | `tasks:read`                                        |
| PATCH  | `/v1/raycast/tasks/{taskId}`                            | [Update a Raycast task](/api-reference/raycast/tasks-update)                 | `tasks:write`                                       |
| POST   | `/v1/raycast/comments`                                  | [Add a comment](/api-reference/raycast/comments-create)                      | `comments:write`                                    |
| GET    | `/v1/raycast/entities/{entityType}/{entityId}/activity` | [Get entity activity](/api-reference/raycast/activity)                       | `activity:read`                                     |
| GET    | `/v1/raycast/objects`                                   | [List Raycast objects](/api-reference/raycast/objects)                       | `objects:read`                                      |
| GET    | `/v1/raycast/objects/{objectSlug}/records`              | [Browse object records](/api-reference/raycast/object-records)               | `objects:read`, `records:read`                      |
| GET    | `/v1/raycast/records/recent`                            | [List recent records](/api-reference/raycast/records-recent)                 | `records:read`                                      |
| GET    | `/v1/raycast/notifications`                             | [List notifications](/api-reference/raycast/notifications)                   | `notifications:read`                                |
| POST   | `/v1/raycast/notifications/{notificationId}/read`       | [Mark notification read](/api-reference/raycast/notifications-read)          | `notifications:write`                               |
| POST   | `/v1/raycast/notifications/{notificationId}/unread`     | [Mark notification unread](/api-reference/raycast/notifications-unread)      | `notifications:write`                               |
| POST   | `/v1/raycast/notifications/read-all`                    | [Mark all notifications read](/api-reference/raycast/notifications-read-all) | `notifications:write`                               |
| DELETE | `/v1/raycast/notifications/{notificationId}`            | [Dismiss a read notification](/api-reference/raycast/notifications-dismiss)  | `notifications:write`                               |
| GET    | `/v1/raycast/brief`                                     | [Get the daily brief](/api-reference/raycast/brief)                          | `tasks:read`, `meetings:read`, `notifications:read` |
| GET    | `/v1/raycast/meetings/upcoming`                         | [List upcoming meetings](/api-reference/raycast/meetings-upcoming)           | `meetings:read`                                     |
| GET    | `/v1/raycast/search`                                    | [Search the workspace](/api-reference/raycast/search)                        | `tasks:read`, `records:read`, `meetings:read`       |

## OAuth

Registered-client authorization and token lifecycle. See [OAuth flow](/api-reference/oauth/overview).

| Method | Path                        | Reference                                                     | Required scopes          |
| ------ | --------------------------- | ------------------------------------------------------------- | ------------------------ |
| GET    | `/oauth/clients/{clientId}` | [Get OAuth client metadata](/api-reference/oauth/client)      | No bearer authentication |
| POST   | `/oauth/authorize`          | [Authorize a workspace grant](/api-reference/oauth/authorize) | Signed-in session        |
| POST   | `/oauth/token`              | [Exchange or refresh tokens](/api-reference/oauth/token)      | No bearer authentication |
| POST   | `/oauth/revoke`             | [Revoke an OAuth grant](/api-reference/oauth/revoke)          | No bearer authentication |

## Compatibility aliases

Four older OAuth paths call the same handlers. They are listed alongside their canonical paths in [OAuth compatibility paths](/api-reference/oauth/overview#compatibility-paths). Use the canonical endpoint when implementing a new client.


## Related topics

- [Authentication and API conventions](/api-reference/authentication.md)
- [Developer quickstart](/api-reference/quickstart.md)
- [Mark all notifications read](/api-reference/raycast/notifications-read-all.md)
- [Raycast API](/api-reference/raycast/overview.md)
- [Objects and records API](/api-reference/objects-and-records.md)