The Opal REST API has 78 endpoints. This table lists every one by area with its method, path, and what it does, and links to the page that explains it. All paths start with https://app.opalrecall.com/api/v1. Every endpoint except the key-management routes uses an API key.
Auth and Limits Recap Topic Summary Base URL https://app.opalrecall.com/api/v1Auth header Authorization: Bearer opal_live_xxx (full access) or opal_read_xxx (read-only)Plan Workshop. Other plans get 403 FEATURE_NOT_IN_PLAN. Read-only keys Only GET, HEAD, and OPTIONS. Other methods return 403. Rate limit 100 requests per key per 60-second window. 429 with Retry-After. Share and publish limits 20 share creations and 20 publish operations per user per 60 seconds. Keys per account Up to 10 active. Response shape Most routes return { "data": ... }. Errors return { "error": "..." }.
See Opal API Keys: Create, Use, and Revoke , Errors, Rate Limits, and Plan Limits in the Opal API , and API Conventions: IDs, Response Format, and Status Codes for the details.
Endpoints by Area Account API keys Items and pages Method Path What it does Guide GET/itemsList owned items Items API: List, Get, Create, Update, and Delete GET/items/inboxList inbox items Items API: List, Get, Create, Update, and Delete GET/items/sharedList items shared with you Items API: List, Get, Create, Update, and Delete GET/items/:idGet item metadata and access Items API: List, Get, Create, Update, and Delete GET/items/:id/pageGet full page content Items API: List, Get, Create, Update, and Delete POST/itemsCreate an item Items API: List, Get, Create, Update, and Delete PATCH/items/:idUpdate an item Items API: List, Get, Create, Update, and Delete DELETE/items/:idDelete an item Items API: List, Get, Create, Update, and Delete POST/items/:id/notify-metadataTell share recipients a field changed Items API: List, Get, Create, Update, and Delete
Files and media Binders Method Path What it does Guide POST/items/:id/binder/itemsAdd items to a binder Binders API: Add, Remove, Reorder, and Duplicate DELETE/items/:id/binder/items/:itemIdRemove an item from a binder Binders API: Add, Remove, Reorder, and Duplicate PATCH/items/:id/binder/reorderReorder binder items Binders API: Add, Remove, Reorder, and Duplicate PATCH/items/:id/owner-controls-itemsToggle owner controls Binders API: Add, Remove, Reorder, and Duplicate POST/items/:id/duplicateDuplicate a binder Binders API: Add, Remove, Reorder, and Duplicate
Fences Method Path What it does Guide POST/items/:id/fence/itemsAdd an item to a fence Fences API: Add Items, Read Children, and Move a Fence DELETE/items/:id/fence/items/:itemIdRemove an item from a fence Fences API: Add Items, Read Children, and Move a Fence GET/items/:id/fence/childrenGet a fence and its children Fences API: Add Items, Read Children, and Move a Fence PATCH/items/:id/fence/items/:itemIdMove an item inside a fence Fences API: Add Items, Read Children, and Move a Fence POST/items/:id/fence/items/batch-moveMove up to 500 items inside a fence Fences API: Add Items, Read Children, and Move a Fence POST/items/:id/fence/moveMove a fence with its children Fences API: Add Items, Read Children, and Move a Fence
Layout Workspaces Method Path What it does Guide GET/workspacesList workspaces Workspaces API: List, Create, Update, Reorder, and Delete GET/workspaces/:idGet a workspace Workspaces API: List, Create, Update, Reorder, and Delete POST/workspacesCreate a workspace Workspaces API: List, Create, Update, Reorder, and Delete PATCH/workspaces/:idUpdate a workspace Workspaces API: List, Create, Update, Reorder, and Delete DELETE/workspaces/:idDelete a workspace Workspaces API: List, Create, Update, Reorder, and Delete PATCH/workspaces/reorderReorder workspaces Workspaces API: List, Create, Update, Reorder, and Delete POST/workspaces/:id/iconUpload a workspace icon Workspaces API: List, Create, Update, Reorder, and Delete DELETE/workspaces/:id/iconDelete a workspace icon Workspaces API: List, Create, Update, Reorder, and Delete
Saved views Method Path What it does Guide GET/viewsList views and settings Saved Views API: Save, List, and Set Your Home View POST/viewsCreate a view Saved Views API: Save, List, and Set Your Home View PATCH/views/:idUpdate a view Saved Views API: Save, List, and Set Your Home View DELETE/views/:idDelete a view Saved Views API: Save, List, and Set Your Home View PATCH/views/settingsSet the Home view and first view Saved Views API: Save, List, and Set Your Home View
Shares Method Path What it does Guide POST/sharesShare an item Sharing API: Shares, Permissions, and Recipient Placement GET/shares/incomingList pending incoming shares Sharing API: Shares, Permissions, and Recipient Placement GET/shares/outgoingList accepted outgoing shares Sharing API: Shares, Permissions, and Recipient Placement GET/shares/:id/already-haveList items in a shared binder or fence that you already have Sharing API: Shares, Permissions, and Recipient Placement POST/shares/:id/acceptAccept a share Sharing API: Shares, Permissions, and Recipient Placement POST/shares/:id/declineDecline a share Sharing API: Shares, Permissions, and Recipient Placement PATCH/shares/:idUpdate permissions or placement Sharing API: Shares, Permissions, and Recipient Placement PATCH/shares/:id/inboxMove a shared item in or out of the inbox Sharing API: Shares, Permissions, and Recipient Placement DELETE/shares/:idRemove or leave a share Sharing API: Shares, Permissions, and Recipient Placement POST/items/:id/reassignHand a shared item, binder, or fence to a member Reassign Owner API: Hand a Shared Item, Binder, or Fence to a Member GET/items/reassign/:transferIdCheck on a reassignment running in the background Reassign Owner API: Hand a Shared Item, Binder, or Fence to a Member
Copies Publishing Method Path What it does Guide POST/items/:id/publishPublish or republish Publishing API: Publish, Refresh, Status, and Unpublish POST/items/:id/publish/refreshRefresh the published snapshot Publishing API: Publish, Refresh, Status, and Unpublish GET/items/:id/publishGet publish status Publishing API: Publish, Refresh, Status, and Unpublish DELETE/items/:id/publishUnpublish Publishing API: Publish, Refresh, Status, and Unpublish
Tasks Method Path What it does Guide GET/tasksList tasks Tasks API: Create, List, Update, and Delete Tasks GET/tasks/:taskIdGet a task Tasks API: Create, List, Update, and Delete Tasks POST/tasksCreate a task Tasks API: Create, List, Update, and Delete Tasks PATCH/tasks/:taskIdUpdate a task Tasks API: Create, List, Update, and Delete Tasks DELETE/tasks/:taskIdDelete a task Tasks API: Create, List, Update, and Delete Tasks
Search Profile Icons OpenGraph Export The key-management routes (POST, GET, and DELETE /keys) use your signed-in Opal session, not an API key. The public publishing routes under /p/ are not part of /api/v1 and do not use API-key auth. See Publishing API: Publish, Refresh, Status, and Unpublish .
Next Steps FAQ How many endpoints does the Opal API have? 78, grouped into account, API keys, items and pages, files and media, binders, fences, layout, workspaces, saved views, shares, copies, publishing, tasks, search, profile, icons, OpenGraph, and export.
Which endpoints work with a read-only key? The GET endpoints. A read-only key can make only GET, HEAD, and OPTIONS requests.
Which endpoints do not use an API key? The key-management routes under /api/v1/keys use your signed-in app session. The public /p/ routes are unauthenticated and are not part of /api/v1.
