Scopes

What each scope unlocks, taken from the operations that require it.

Updated 16 Sep 20261 min read

A key carries scopes and an operation requires them. Ask for the least a client needs: a key that can only read cannot delete a board by accident.

Scopes

ai:generate11 operations

Spending credits on generation, and managing skills. Covers POST /boards/{boardId}/items/{itemId}/convert, POST /boards/{boardId}/ai/ask, POST /boards/{boardId}/ai/generate and 8 more.

boards:read22 operations

Reading spaces, boards, items, activity, presence, chat and search. Covers GET /spaces, GET /spaces/{spaceId}, GET /spaces/{spaceId}/members and 19 more.

boards:write18 operations

Creating and changing spaces, boards and items, comments included. Covers POST /spaces, PATCH /spaces/{spaceId}, DELETE /spaces/{spaceId} and 15 more.

members:write5 operations

Sharing a space, changing roles and controlling public links. Covers POST /spaces/{spaceId}/members, PATCH /spaces/{spaceId}/members/{email}, DELETE /spaces/{spaceId}/members/{email} and 2 more.

user:read10 operations

Who the token belongs to, its plan, limits, credits and notifications. Covers GET /me, GET /me/credits, GET /me/limits and 7 more.

A scope is necessary, not sufficient. A key with boards:write still cannot touch a board the account behind it cannot open.

Was this page helpful?