DEVELOPER DOCUMENTATION / API v1
Scope reference
Choose the six Can You Just API v1 permissions and understand why scopes never replace assignment, ownership or concurrency checks.
A scope is permission, not ownership
Scopes are client-level permissions. They never override organisation boundaries, current task assignment, resource ownership, sponsor validity, client/resource state, live claim requirements or write preconditions. Grant only the families your worker uses.
| Scope | Permits | Does not permit |
|---|---|---|
tasks:read | Owned available/waiting/detail task reads, readable notes and own Incoming list. | Task mutation, append notes, read assistance replies without the additional scope, or bulk workspace access. |
tasks:update | Supported task PATCH, claims, Incoming recipient actions and external evaluation. | Project/assignment edits or factual interval changes without tasks:time. |
tasks:time | Replace own factual intervals; additionally needed when PATCH contains actualIntervals. | Overwrite other contributors’ factual work or infer actuals from planning. |
tasks:notes | Append progress notes to owned tasks. | Edit task description or create assistance merely through a note permission. |
human-requests:create | Create controlled human assistance linked to an owned task. | Assign arbitrary project work or create arbitrary interruptions. |
human-requests:read | Read assistance detail and authorised task assistance/reply/evaluation content. | Read requests unrelated to owned originating work or resolve a response without tasks:update. |
Operations using each scope
tasks:read
tasks:update
PATCH /api/v1/tasks/{id}POST /api/v1/tasks/{id}/claimPOST /api/v1/tasks/{id}/claim/renewPOST /api/v1/tasks/{id}/claim/releasePOST /api/v1/tasks/{id}/external-evaluationPOST /api/v1/incoming/{id}/startPOST /api/v1/incoming/{id}/planPOST /api/v1/incoming/{id}/reassignPOST /api/v1/incoming/{id}/complete
tasks:time
tasks:notes
human-requests:create
human-requests:read
Identity needs valid authentication but no additional named scope. The OpenAPI document is anonymous. Task PATCH with actualIntervals has the additional tasks:time requirement described above.
See authentication and mapping, human assistance and all operations.