Scopes
A token needs the scopes required by the operation, plus mcp for an MCP connection. A missing scope returns 403.
In token requests, prefix each scope below with https://api.filemark.ca/ and separate the names with spaces.
scope=https://api.filemark.ca/clients:read https://api.filemark.ca/mcp| Short scope | Grants |
|---|---|
mcp | Connect to the MCP server |
tax:compute | List computation targets, read their cell contracts, and run computations |
clients:read | List or get clients |
entities:read | List or get legal entities |
tax-years:read | List or get tax years |
engagements:read | Search, list and get engagements, their amendment context and history, and the form catalog |
tax-data:read | Read saved trial-balance and account data. Scenario computations also need tax:compute |
documents:read | List and get document metadata |
workpapers:read | List and get workpapers, their evidence, account links, tie-out and versions, and validate a workpaper |
review:read | Get the engagement review summary, and list account notes and review marks |
exports:create | Start an export job for an engagement's filing handoff or a separate scenario draft package |
exports:read | List and get export jobs |
clients:write | Create, update, archive and restore clients |
entities:write | Create, update, archive and restore legal entities |
engagements:write | Create, update, archive and restore engagements |
tax-data:write | Land a trial balance and apply saved tax-data actions such as GIFI mapping, classification answers and adjusting entries |
documents:write | Upload, classify, ingest, replace and archive documents. Creating a document delivery also needs documents:read |
workpapers:write | Create, update, archive, restore, generate and carry forward workpapers, and manage their evidence and account links |
review:annotate | Create and update account notes and question or correction review marks |
portal:read | List portal contacts and requests, and get a portal request |
portal:write | Preview and apply portal actions. Commenting also needs portal:send |
portal:send | Comment on portal requests, and send, remind or cancel portal invitations. Server integrations only |
integrations:read | List integration connections and sources, preview a sync, and get a sync |
integrations:sync | Apply a previewed integration sync. Server integrations only |
exports:deliver | Get a download URL for a finished export job's package. Server integrations only |
Any of clients:write, entities:write, engagements:write or tax-data:write also reads an engagement's mutation preconditions. See Write data.