Operately API docs
Operately API provides HTTP endpoints for querying and mutating Operately resources.
Start here#
-
Create an API token to authenticate your requests.
-
Use the Operately CLI if you want to work with the API from your terminal.
-
Every endpoint is authenticated with an API token.
-
Use the header
Authorization: Bearer <token>. -
Queries are read operations (
GET). -
Mutations are write operations (
POST). -
Read-only tokens cannot execute mutations and return
403.
Endpoint Namespaces#
| Namespace | Queries | Mutations | Total |
|---|---|---|---|
| Comments | 1 | 3 | 4 |
| Companies | 7 | 13 | 20 |
| Documents | 1 | 4 | 5 |
| Goals | 8 | 32 | 40 |
| Links | 1 | 3 | 4 |
| Notifications | 3 | 6 | 9 |
| People | 9 | 3 | 12 |
| Projects | 17 | 37 | 54 |
| Reactions | 0 | 2 | 2 |
| Resource hubs | 3 | 6 | 9 |
| Spaces | 10 | 14 | 24 |
| Tasks | 3 | 10 | 13 |