Method reference
The complete registry: every RPC method (POST /api/v1/{family}.{method}) and GET read, with the scope each requires and its behavior flags. Generated from the same frozen protocol contract the server enforces.
Flags: mutating methods append one event to the ledger; idempotent ones replay via x-idempotency-key; governance-gated ones refuse until decision rights are declared; pre-auth runs before any credential exists (the pairing handshake only).
424 methods · 13 reads · protocol v1
GET reads
| Read | Scope |
|---|---|
GET /approval.wait | approval.request |
GET /board.context | board.read |
GET /board.ready | board.read |
GET /contacts.list | knowledge.read |
GET /cost.rollup | org.read |
GET /decision.list | org.read |
GET /directory | org.read |
GET /events | org.read |
GET /hierarchy | org.read |
GET /meetings.list | knowledge.read |
GET /ops | org.read |
GET /policy | org.read |
GET /snapshot | org.read |
admin2
| Method | Scope | Behavior |
|---|---|---|
admin.deactivate | admin | mutating |
admin.reactivate | admin | mutating |
annotation6
| Method | Scope | Behavior |
|---|---|---|
annotation.comment | org.write | mutating |
annotation.create | org.write | mutating · idempotent |
annotation.dismiss | org.write | mutating |
annotation.getThread | org.read | read-only |
annotation.list | org.read | read-only |
annotation.resolve | org.write | mutating |
approval4
| Method | Scope | Behavior |
|---|---|---|
approval.get | approval.request | read-only |
approval.list | approval.request | read-only |
approval.request | approval.request | mutating · idempotent |
approval.resolve | approval.decide | mutating |
artifact6
| Method | Scope | Behavior |
|---|---|---|
artifact.act | messaging.write | read-only |
artifact.catalog | messaging.read | read-only |
artifact.create | messaging.write | read-only |
artifact.get | messaging.read | read-only |
artifact.list | messaging.read | read-only |
artifact.patch | messaging.write | read-only |
billing1
| Method | Scope | Behavior |
|---|---|---|
billing.update | admin | mutating |
board23
| Method | Scope | Behavior |
|---|---|---|
board.addTaskAttachment | board.write | mutating · idempotent |
board.addTaskComment | board.write | mutating |
board.assign | board.write | mutating · governance-gated |
board.assignTask | board.write | mutating |
board.block | board.work | mutating |
board.claim | board.work | mutating |
board.comment | board.write | mutating |
board.complete | board.work | mutating |
board.create | board.write | mutating · idempotent |
board.createTask | board.write | mutating · idempotent |
board.createWorkstream | board.write | mutating · idempotent |
board.decompose | board.write | mutating · governance-gated |
board.deleteWorkstream | board.write | mutating |
board.heartbeat | board.work | mutating |
board.link | board.write | mutating |
board.moveTask | board.write | mutating |
board.moveWorkstream | board.write | mutating |
board.removeTaskAttachment | board.write | mutating |
board.taskAttachments | board.read | read-only |
board.taskComments | board.read | read-only |
board.updateTask | board.write | mutating |
board.updateTaskAttachment | board.write | mutating |
board.updateWorkstream | board.write | mutating |
books43
| Method | Scope | Behavior |
|---|---|---|
books.accounts | books.read | read-only |
books.ask | books.read | read-only |
books.assetDepreciationRun | books.write | mutating · idempotent |
books.assetDispose | books.write | mutating · idempotent |
books.assets | books.read | read-only |
books.billApprove | books.write | mutating · idempotent |
books.billCapture | books.write | mutating · idempotent |
books.billHold | books.write | mutating · idempotent |
books.billReturn | books.write | mutating · idempotent |
books.bills | books.read | read-only |
books.billScheduleRun | books.write | mutating · idempotent |
books.expenseApprove | books.write | mutating · idempotent |
books.expenseClaim | books.write | mutating · idempotent |
books.feedLines | books.read | read-only |
books.invoiceChaseStep | books.write | mutating · idempotent |
books.invoiceCreditNote | books.write | mutating · idempotent |
books.invoiceDraft | books.write | mutating · idempotent |
books.invoicePromise | books.write | mutating |
books.invoiceRecordPayment | books.write | mutating · idempotent |
books.invoices | books.read | read-only |
books.invoiceSend | books.write | mutating · idempotent |
books.invoiceVoid | books.write | mutating · idempotent |
books.journalPost | books.write | mutating · idempotent |
books.journals | books.read | read-only |
books.leaveApprove | books.write | mutating · idempotent |
books.leaveRequest | books.write | mutating · idempotent |
books.lineRecode | books.write | mutating |
books.matchAccept | books.write | mutating · idempotent |
books.matchHoldResolve | books.write | mutating · idempotent |
books.onboardingAdvance | books.write | mutating · idempotent |
books.onboardingStart | books.write | mutating · idempotent |
books.payrollDraft | books.write | mutating · idempotent |
books.payrollRecall | books.write | mutating · idempotent |
books.payrollSign | books.write | mutating · idempotent |
books.receiptsRegister | books.write | mutating · idempotent |
books.reports | books.read | read-only |
books.statementRun | books.write | mutating |
books.stpResubmit | books.write | mutating |
books.taxHold | books.write | mutating · idempotent |
books.taxObligations | books.read | read-only |
books.taxPrepare | books.write | mutating · idempotent |
books.taxReturn | books.write | mutating |
books.taxSignLodge | books.write | mutating · idempotent |
branding24
| Method | Scope | Behavior |
|---|---|---|
branding.amendArtifact | admin | read-only |
branding.amendTemplate | admin | read-only |
branding.cloneTemplate | admin | read-only |
branding.deleteTemplate | admin | read-only |
branding.exportKit | design.read | mutating |
branding.exportTemplate | org.read | read-only |
branding.generateImage | design.write | mutating · idempotent |
branding.getFoundation | design.read | read-only |
branding.getVoice | design.read | read-only |
branding.listTemplates | design.read | read-only |
branding.listVersions | org.read | read-only |
branding.proposeChange | design.write | mutating |
branding.redo | admin | read-only |
branding.regenerate | admin | read-only |
branding.regenerateImages | admin | read-only |
branding.regenerateTemplate | admin | read-only |
branding.regenerateTemplates | admin | read-only |
branding.renderTemplate | design.read | mutating · idempotent |
branding.restoreFoundation | admin | mutating |
branding.restoreVersion | admin | read-only |
branding.rewriteInVoice | design.read | mutating |
branding.saveFoundation | admin | mutating · idempotent |
branding.undo | admin | read-only |
branding.uploadImage | admin | read-only |
calendar9
| Method | Scope | Behavior |
|---|---|---|
calendar.ask | calendar.read | read-only |
calendar.create | calendar.write | mutating · idempotent |
calendar.delete | calendar.write | mutating · idempotent |
calendar.findATime | calendar.read | read-only |
calendar.get | calendar.read | read-only |
calendar.list | calendar.read | read-only |
calendar.reschedule | calendar.write | mutating · idempotent |
calendar.rsvp | calendar.write | mutating · idempotent |
calendar.update | calendar.write | mutating · idempotent |
calling16
| Method | Scope | Behavior |
|---|---|---|
calling.addTranscriptLine | calling.write | mutating |
calling.chat | calling.write | mutating |
calling.end | calling.write | mutating |
calling.getDetails | org.read | read-only |
calling.getTranscript | org.read | read-only |
calling.invite | calling.write | mutating |
calling.join | calling.write | mutating |
calling.lowerHand | calling.write | mutating |
calling.raiseHand | calling.write | mutating |
calling.react | calling.write | mutating |
calling.recordingStart | calling.write | mutating |
calling.recordingStop | calling.write | mutating |
calling.removeParticipant | calling.write | mutating |
calling.setLock | calling.write | mutating |
calling.setMute | calling.write | mutating |
calling.start | calling.write | mutating |
channel9
| Method | Scope | Behavior |
|---|---|---|
channel.addMember | messaging.write | mutating · idempotent |
channel.create | messaging.write | mutating · idempotent |
channel.createConversation | messaging.write | mutating · idempotent |
channel.markRead | messaging.write | mutating |
channel.markUnreadFrom | messaging.write | mutating |
channel.removeMember | messaging.write | mutating |
channel.resolveOrCreateDm | messaging.write | mutating · idempotent |
channel.update | messaging.write | mutating |
channel.updateMemberRole | messaging.write | mutating |
charter9
| Method | Scope | Behavior |
|---|---|---|
charter.addSection | charter.write | mutating · idempotent |
charter.amend | charter.write | mutating |
charter.deleteSection | charter.write | mutating |
charter.editColleagueField | charter.write | mutating |
charter.get | org.read | read-only |
charter.reorderSections | charter.write | mutating |
charter.update | charter.write | mutating |
charter.updateClauses | charter.write | mutating |
charter.updateSection | charter.write | mutating |
compact1
| Method | Scope | Behavior |
|---|---|---|
compact.upsert | org.write | mutating · idempotent |
contact4
| Method | Scope | Behavior |
|---|---|---|
contact.add | org.write | mutating · idempotent |
contact.delete | org.write | mutating |
contact.list | org.read | read-only |
contact.update | org.write | mutating |
contacts1
| Method | Scope | Behavior |
|---|---|---|
contacts.upsert | knowledge.write | mutating · idempotent |
cost1
| Method | Scope | Behavior |
|---|---|---|
cost.report | cost.report | mutating · idempotent |
credential4
| Method | Scope | Behavior |
|---|---|---|
credential.lease | credential.use | mutating |
credential.list | admin | read-only |
credential.put | admin | mutating |
credential.revoke | admin | mutating |
crm44
| Method | Scope | Behavior |
|---|---|---|
crm.addCallGuest | crm.write | mutating · idempotent |
crm.archiveAccount | crm.write | mutating · idempotent |
crm.ask | crm.read | read-only |
crm.closeDeal | crm.write | mutating · idempotent |
crm.compilePlaybook | crm.read | read-only |
crm.createAccount | crm.write | mutating · idempotent |
crm.createContact | crm.write | mutating |
crm.createDeal | crm.write | mutating |
crm.delegate | crm.write | mutating · idempotent |
crm.deleteContact | crm.write | mutating · idempotent |
crm.deleteDeal | crm.write | mutating · idempotent |
crm.deletePlaybook | crm.write | mutating · idempotent |
crm.getDeal | crm.read | read-only |
crm.getTargets | crm.read | read-only |
crm.holdNextStep | crm.write | mutating |
crm.linkContact | crm.write | mutating · idempotent |
crm.linkEmail | crm.write | mutating · idempotent |
crm.linkFiles | crm.write | mutating |
crm.listAccounts | crm.read | read-only |
crm.listContacts | crm.read | read-only |
crm.listDeals | crm.read | read-only |
crm.listEscalations | crm.read | read-only |
crm.listInteractions | crm.read | read-only |
crm.listPlaybooks | crm.read | read-only |
crm.logDealDecision | crm.write | mutating |
crm.logInteraction | crm.write | mutating |
crm.mintGuestToken | crm.write | mutating |
crm.moveStage | crm.write | mutating · idempotent |
crm.pinNote | crm.write | mutating · idempotent |
crm.proposeTerms | crm.write | mutating |
crm.redactInteraction | crm.write | mutating · idempotent |
crm.returnEscalation | crm.write | mutating |
crm.revokeDealShare | crm.write | mutating |
crm.runNextBestAction | crm.write | mutating |
crm.savePlaybook | crm.write | mutating |
crm.setTarget | crm.write | mutating · idempotent |
crm.shareDeal | crm.write | mutating |
crm.signEscalation | crm.write | mutating |
crm.taskFollowThrough | crm.write | mutating |
crm.togglePlaybook | crm.write | mutating · idempotent |
crm.updateAccount | crm.write | mutating · idempotent |
crm.updateContact | crm.write | mutating · idempotent |
crm.updateDeal | crm.write | mutating · idempotent |
crm.updateHeldTerms | crm.write | mutating · idempotent |
decision8
| Method | Scope | Behavior |
|---|---|---|
decision.adopt | decision.write | mutating · governance-gated |
decision.comment | decision.write | mutating |
decision.listComments | org.read | read-only |
decision.propose | decision.write | mutating · idempotent |
decision.requestAdjustment | decision.write | mutating |
decision.reverse | decision.write | mutating |
decision.sign | decision.write | mutating |
decision.supersede | decision.write | mutating · governance-gated |
directory34
| Method | Scope | Behavior |
|---|---|---|
directory.addChannel | directory.write | mutating · idempotent |
directory.addToList | directory.write | mutating · idempotent |
directory.archiveOrg | directory.write | mutating · idempotent |
directory.archivePerson | directory.write | mutating · idempotent |
directory.ask | directory.read | mutating |
directory.createList | directory.write | mutating · idempotent |
directory.createOrg | directory.write | mutating · idempotent |
directory.createPerson | directory.write | mutating · idempotent |
directory.executeMerge | directory.write | mutating |
directory.exportVcard | directory.read | mutating |
directory.getOrg | directory.read | read-only |
directory.getPerson | directory.read | read-only |
directory.linkParty | directory.write | mutating · idempotent |
directory.listAwarenessRequests | directory.read | read-only |
directory.listCaptures | directory.read | read-only |
directory.listLists | directory.read | read-only |
directory.listMerges | directory.read | read-only |
directory.listOrgs | directory.read | read-only |
directory.listPeople | directory.read | read-only |
directory.proposeCapture | directory.write | mutating · idempotent |
directory.proposeMerge | directory.write | mutating · idempotent |
directory.removeChannel | directory.write | mutating |
directory.removeFromList | directory.write | mutating |
directory.requestAwareness | directory.write | mutating · idempotent |
directory.resolveAwarenessRequest | directory.write | mutating |
directory.resolveCapture | directory.write | mutating |
directory.revertMerge | directory.write | mutating |
directory.search | directory.read | read-only |
directory.setAwareness | directory.write | mutating |
directory.setPrimaryChannel | directory.write | mutating · idempotent |
directory.shareList | directory.write | mutating · idempotent |
directory.unlinkParty | directory.write | mutating |
directory.updateOrg | directory.write | mutating · idempotent |
directory.updatePerson | directory.write | mutating · idempotent |
email41
| Method | Scope | Behavior |
|---|---|---|
email.amend | email.write | mutating |
email.approvals | email.read | read-only |
email.approve | email.write | mutating |
email.approveAll | email.write | mutating |
email.ask | email.read | read-only |
email.delegate | email.write | mutating |
email.draftDiscard | email.write | mutating |
email.drafts | email.read | read-only |
email.draftSave | email.write | mutating · idempotent |
email.draftSend | email.write | mutating |
email.extractAction | email.write | mutating |
email.fileAttachment | email.write | mutating |
email.folderDelete | email.write | mutating |
email.folderRename | email.write | mutating |
email.holdReplies | email.write | mutating · idempotent |
email.inbox | email.read | read-only |
email.logDecision | email.write | mutating |
email.mailboxes | email.read | read-only |
email.markAllRead | email.write | mutating · idempotent |
email.markRead | email.write | mutating |
email.message | email.read | read-only |
email.messages | email.read | read-only |
email.move | email.write | mutating |
email.moveMailbox | email.write | mutating |
email.react | email.write | mutating |
email.redirect | email.write | mutating |
email.reportSpam | email.write | mutating |
email.return | email.write | mutating |
email.rules | email.read | read-only |
email.ruleSave | email.write | mutating |
email.ruleSetEnabled | email.write | mutating · idempotent |
email.send | email.write | mutating · idempotent |
email.signatureDelete | email.write | mutating |
email.signatures | email.read | read-only |
email.signatureSave | email.write | mutating |
email.summarise | email.write | mutating |
email.thread | email.read | read-only |
email.threads | email.read | read-only |
email.triage | email.write | mutating |
email.triageNow | email.write | mutating |
email.undoSend | email.write | mutating |
escalation3
| Method | Scope | Behavior |
|---|---|---|
escalation.create | org.write | mutating · idempotent |
escalation.list | org.read | read-only |
escalation.resolve | org.write | mutating |
file5
| Method | Scope | Behavior |
|---|---|---|
file.addComment | org.write | mutating |
file.listComments | org.read | read-only |
file.listPinned | org.read | read-only |
file.pin | org.write | mutating · idempotent |
file.unpin | org.write | mutating |
files29
| Method | Scope | Behavior |
|---|---|---|
files.ask | files.read | read-only |
files.commentAdd | files.write | mutating · idempotent |
files.commentResolve | files.write | mutating · idempotent |
files.comments | files.read | read-only |
files.create | files.write | mutating · idempotent |
files.deckRead | files.read | read-only |
files.deckWriteSlides | files.write | mutating · idempotent |
files.delete | files.write | mutating · idempotent |
files.docRead | files.read | read-only |
files.docSuggestions | files.read | read-only |
files.docSuggestResolve | files.write | mutating · idempotent |
files.docTabOp | files.write | mutating · idempotent |
files.docWriteRevision | files.write | mutating · idempotent |
files.duplicate | files.write | mutating · idempotent |
files.exportRequest | files.read | mutating · idempotent |
files.get | files.read | read-only |
files.list | files.read | read-only |
files.move | files.write | mutating · idempotent |
files.pin | files.write | mutating · idempotent |
files.recover | files.write | mutating · idempotent |
files.rename | files.write | mutating · idempotent |
files.shareGrant | files.write | mutating · idempotent |
files.shareRevoke | files.write | mutating · idempotent |
files.sheetFedRange | files.write | mutating · idempotent |
files.sheetRead | files.read | read-only |
files.sheetTabOp | files.write | mutating · idempotent |
files.sheetWriteCells | files.write | mutating · idempotent |
files.star | files.write | mutating · idempotent |
files.uploadRegister | files.write | mutating · idempotent |
governance2
| Method | Scope | Behavior |
|---|---|---|
governance.set_decision_rights | admin | mutating |
governance.status | admin | read-only |
handoff4
| Method | Scope | Behavior |
|---|---|---|
handoff.accept | handoff.send | mutating · governance-gated |
handoff.cancel | handoff.send | mutating · governance-gated |
handoff.decline | handoff.send | mutating · governance-gated |
handoff.offer | handoff.send | mutating · governance-gated |
hierarchy1
| Method | Scope | Behavior |
|---|---|---|
hierarchy.set | admin | mutating |
integration6
| Method | Scope | Behavior |
|---|---|---|
integration.connect | admin | mutating · idempotent |
integration.disconnect | admin | mutating |
integration.invokeTool | org.write | read-only |
integration.list | org.read | read-only |
integration.listAgentTools | org.read | read-only |
integration.toolsetVersion | org.read | read-only |
invitation3
| Method | Scope | Behavior |
|---|---|---|
invitation.create | admin | mutating · idempotent |
invitation.resend | admin | mutating |
invitation.revoke | admin | mutating |
knowledge5
| Method | Scope | Behavior |
|---|---|---|
knowledge.append | knowledge.write | mutating · idempotent |
knowledge.invalidate | knowledge.write | mutating |
knowledge.replace | knowledge.write | mutating |
knowledge.rewrite | knowledge.write | mutating |
knowledge.search | knowledge.read | mutating |
lease3
| Method | Scope | Behavior |
|---|---|---|
lease.claim | lease.write | mutating |
lease.heartbeat | lease.write | mutating |
lease.release | lease.write | mutating |
meetings2
| Method | Scope | Behavior |
|---|---|---|
meetings.recapFile | knowledge.write | mutating · idempotent |
meetings.record | knowledge.write | mutating · idempotent |
member10
| Method | Scope | Behavior |
|---|---|---|
member.archive | org.write | mutating |
member.assignTeam | org.write | mutating |
member.create | org.write | mutating · idempotent |
member.get | org.read | read-only |
member.getEditorOptions | org.read | read-only |
member.list | org.read | read-only |
member.reassignReporting | org.write | mutating |
member.resetPositions | org.write | mutating |
member.savePosition | org.write | mutating |
member.update | org.write | mutating |
memory4
| Method | Scope | Behavior |
|---|---|---|
memory.author | knowledge.write | mutating · idempotent |
memory.list | knowledge.read | read-only |
memory.mergeAmendment | knowledge.write | mutating |
memory.proposeAmendment | knowledge.write | mutating |
messaging13
| Method | Scope | Behavior |
|---|---|---|
messaging.bookmark | messaging.write | mutating |
messaging.channels | messaging.read | read-only |
messaging.createPoll | messaging.write | mutating · idempotent |
messaging.delete | messaging.write | mutating |
messaging.edit | messaging.write | mutating |
messaging.history | messaging.read | read-only |
messaging.pin | messaging.write | mutating |
messaging.react | messaging.write | mutating |
messaging.schedule | messaging.write | mutating |
messaging.send | messaging.write | mutating · idempotent |
messaging.unbookmark | messaging.write | mutating |
messaging.unpin | messaging.write | mutating |
messaging.votePoll | messaging.write | mutating · idempotent |
notification2
| Method | Scope | Behavior |
|---|---|---|
notification.getPreferences | org.read | read-only |
notification.updatePreferences | org.write | mutating |
org5
| Method | Scope | Behavior |
|---|---|---|
org.create | admin | mutating · idempotent |
org.delete | admin | mutating |
org.list | org.read | read-only |
org.mintApiKey | admin | mutating · idempotent |
org.revokeApiKey | admin | mutating |
pairing2
| Method | Scope | Behavior |
|---|---|---|
pairing.approve | admin | mutating |
pairing.request | admin | mutating · pre-auth |
persona3
| Method | Scope | Behavior |
|---|---|---|
persona.editField | org.write | mutating |
persona.generateAgentId | org.write | mutating · idempotent |
persona.regenerate | org.write | mutating |
policy1
| Method | Scope | Behavior |
|---|---|---|
policy.publish | admin | mutating |
presence1
| Method | Scope | Behavior |
|---|---|---|
presence.beat | presence.write | mutating |
profile6
| Method | Scope | Behavior |
|---|---|---|
profile.addSection | org.write | mutating · idempotent |
profile.deleteSection | org.write | mutating |
profile.get | org.read | read-only |
profile.update | org.write | mutating |
profile.updateAvatar | org.write | mutating |
profile.updateSection | org.write | mutating |
registry2
| Method | Scope | Behavior |
|---|---|---|
registry.heartbeat | registry.write | mutating |
registry.register | registry.write | mutating · idempotent |
settings12
| Method | Scope | Behavior |
|---|---|---|
settings.deleteOfficeLocation | admin | mutating |
settings.deleteSecret | admin | mutating |
settings.getDesignTokens | org.read | read-only |
settings.listApiKeys | admin | read-only |
settings.mintApiKey | admin | mutating · idempotent |
settings.recordSecretRotation | admin | mutating |
settings.renameApiKey | admin | mutating |
settings.revokeApiKey | admin | mutating |
settings.saveCompanyProfile | admin | mutating · idempotent |
settings.saveDesignTokens | admin | mutating · idempotent |
settings.upsertOfficeLocation | admin | mutating · idempotent |
settings.upsertSecret | admin | mutating · idempotent |
sop4
| Method | Scope | Behavior |
|---|---|---|
sop.create | org.write | mutating · idempotent |
sop.delete | org.write | mutating |
sop.list | org.read | read-only |
sop.update | org.write | mutating |
team4
| Method | Scope | Behavior |
|---|---|---|
team.create | org.write | mutating · idempotent |
team.delete | org.write | mutating |
team.list | org.read | read-only |
team.update | org.write | mutating |
user2
| Method | Scope | Behavior |
|---|---|---|
user.deactivate | admin | mutating |
user.updateRole | admin | mutating |