Reference
OAuth scopes
Every Tidy OAuth 2.1 scope, grouped by resource. Scopes are the primary capability gate: a token's scopes control what it can read, write, and manage. All scope names are stable per our deprecation policy (breaking a scope name requires an ADR).
Derived from the OpenAPI spec at /openapi.json.
activities
| Scope | Description |
|---|---|
activities:archive | Archive and unarchive tasks and activities (reversible) |
admin
| Scope | Description |
|---|---|
admin:audit | Read workspace-wide audit log |
admin:members | Manage workspace members |
admin:workspace | Manage workspace settings |
agent_control
| Scope | Description |
|---|---|
agent_control:write | Send control events to running agents |
agent_ledger
| Scope | Description |
|---|---|
agent_ledger:read | Query the operation ledger for your visible work |
agent_ledger:write | Ingest captured operations into the ledger |
agent_sessions
| Scope | Description |
|---|---|
agent_sessions:read | Read agent conversations |
agent_sessions:write | Record agent conversations |
assistant
| Scope | Description |
|---|---|
assistant:invoke | Invoke the Tidy assistant from connected clients |
audit
| Scope | Description |
|---|---|
audit:read | Read audit log entries |
calendar
| Scope | Description |
|---|---|
calendar:delete | Delete calendar events |
calendar:read | Read your calendar events |
calendar:write | Create and update calendar events |
chat
| Scope | Description |
|---|---|
chat:send | Send chat messages on your behalf |
comments
| Scope | Description |
|---|---|
comments:read | Read comments on your items |
comments:write | Create and update comments |
contacts
| Scope | Description |
|---|---|
contacts:read | Read your contacts |
contacts:write | Create and update contacts |
data
| Scope | Description |
|---|---|
data:export | Export your Tidy data as a downloadable archive |
data:import | Import data into Tidy from external sources |
| Scope | Description |
|---|---|
email:patch | Update email read/star/label state |
email:read | Read your emails |
email:send | Send emails on your behalf |
email:triage | Triage (screen, categorize) your inbox |
evidence
| Scope | Description |
|---|---|
evidence:read | Read agent evidence records |
evidence:write | Record agent evidence |
facets
| Scope | Description |
|---|---|
facets:extract | Extract facets from your content |
facets:manage | Create and modify facet definitions (schemas) |
facets:read | Read extracted facets (structured data) |
files
| Scope | Description |
|---|---|
files:delete | Delete files |
files:read | Read your files |
files:write | Upload and update files |
links
| Scope | Description |
|---|---|
links:write | Create and modify typed links between items |
memory
| Scope | Description |
|---|---|
memory:enrich | Contribute derived facts to your shared memory |
memory:observe | Record the agent's own episodic observations |
memory:recall | Recall structured facets and relationships |
memory:search | Search your memory graph |
mobile_devices
| Scope | Description |
|---|---|
mobile_devices:write | Register mobile devices for notifications and sync |
notes
| Scope | Description |
|---|---|
notes:delete | Delete notes |
notes:patch | Update existing notes |
notes:read | Read your notes |
notes:write | Create new notes |
openapi
| Scope | Description |
|---|---|
openapi:read | Discover the Tidy API via OpenAPI spec |
podcast
| Scope | Description |
|---|---|
podcast:generate | Generate podcast episodes from your content |
podcast:read | Read your podcast subscriptions and episodes |
podcast:write | Subscribe to podcasts and manage your playlists and play queue |
primitives
| Scope | Description |
|---|---|
primitives:read | Read workspace primitives created from facets |
primitives:write | Create and update workspace primitives |
projects
| Scope | Description |
|---|---|
projects:read | Read your projects |
projects:write | Create and update projects |
search
| Scope | Description |
|---|---|
search:read | Search your Tidy library |
sms
| Scope | Description |
|---|---|
sms:send | Send SMS messages on your behalf |
tags
| Scope | Description |
|---|---|
tags:read | Read your tag library |
tasks
| Scope | Description |
|---|---|
tasks:read | Read your tasks |
tasks:write | Create and update tasks |
templates
| Scope | Description |
|---|---|
templates:manage | Create, update, and delete templates |
tokens
| Scope | Description |
|---|---|
tokens:manage | Manage your API tokens |
views
| Scope | Description |
|---|---|
views:manage | Configure database views and saved views |
webhooks
| Scope | Description |
|---|---|
webhooks:manage | Manage outbound webhook subscriptions |
workflow
| Scope | Description |
|---|---|
workflow:cancel | Cancel running workflows |
workflow:execute | Execute workflows on your behalf |
workflow:status | Check workflow status |