MCP
A műveletek leírása angolul marad. A magyar szöveg anyanyelvi ellenőrzésre vár.
Csatlakoztasd az AI-alkalmazásodat az MCP-hez. Csak azokat az eszközöket látod, amelyeket a szerepköröd és a kulcsod enged.
Connect an AI app. Tools appear only when your role and credential allow them. Calls use current permissions. Destructive actions use a preview and confirmation token.
ai
getAiCredits
Read workspace Sergio credits
Capability: ai.credits.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
updateAiCredits
Set Sergio credit mode and monthly spending cap
Capability: ai.credits.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| mode | input | “payg” / “hard” | yes |
| spendCapEuros | input | integer | yes |
getMyAiCreditUsage
Read your chat message credits and your UTC daily and monthly totals. Current streaming answer is not settled yet.
Capability: ai.credits.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| conversationId | input | string | yes |
boards
presentMetrics
Compute a widget query and return totals, up to 20 groups and a widget block. Pass widget and optional timeZone; no paging.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| timeZone | input | string | no |
| widget | input | { family?: “metric”, id?: string, kind: “kpi” / “progress” / “bar” / “line” / “stacked” / “table” / “donut”, title?: string, tableId: string, metrics: array | yes |
queryMetrics
Compute sums, averages, counts and percents over a table’s readable rows, optionally grouped by a select/status field or date bucket.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| dateField | input | string | no |
| filters | input | array<{ field: string, op: “eq” / “neq”, value: string or number or boolean } or { field: string, op: “in”, values: array |
no |
| groupBy | input | array<{ field: string } or { date: “day” / “week” / “month” }> | no |
| metrics | input | array<{ op: “sum” / “avg” / “min” / “max” / “countRows” / “countNonNull” / “countDistinct” / “percent”, field?: string, of?: “countRows” / “sum”, numerator?: array |
yes |
| range | input | { preset: “today” / “thisWeek” / “lastWeek” / “thisMonth” / “lastMonth” } or { lastDays: integer } or { from: string, to: string } | no |
| tableId | input | string | yes |
| timeZone | input | string | no |
validateMetrics
Check a metric query against the table’s fields and the caller’s field access, without running it.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| dateField | input | string | no |
| filters | input | array<{ field: string, op: “eq” / “neq”, value: string or number or boolean } or { field: string, op: “in”, values: array |
no |
| groupBy | input | array<{ field: string } or { date: “day” / “week” / “month” }> | no |
| metrics | input | array<{ op: “sum” / “avg” / “min” / “max” / “countRows” / “countNonNull” / “countDistinct” / “percent”, field?: string, of?: “countRows” / “sum”, numerator?: array |
yes |
| range | input | { preset: “today” / “thisWeek” / “lastWeek” / “thisMonth” / “lastMonth” } or { lastDays: integer } or { from: string, to: string } | no |
| tableId | input | string | yes |
| timeZone | input | string | no |
getRecordActivity
Return permission-masked record history. Pass recordId and optional cursor/limit; follow nextCursor for more.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| limit | input | integer | no |
| recordId | input | string | yes |
createRecord
Create a record in a table.
Capability: boards.records.create. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fields | input | object | yes |
| id | input | string | no |
| idempotencyKey | input | string | no |
| tableId | input | string | yes |
exportRecords
Export tableId and optional viewId as masked CSV/XLSX. Returns filename, contentType and base64 body over MCP, up to 1 MiB; use REST for larger files. No paging.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| format | input | “csv” / “xlsx” | no |
| locale | input | “en” / “hu” | no |
| tableId | input | string | yes |
| viewId | input | string | no |
getRecord
Get one record by id.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| recordId | input | string | yes |
listRecords
List the records of a table, ordered by id, one page at a time.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| limit | input | integer | no |
| tableId | input | string | yes |
moveRecord
Move a record between readable neighbours and/or patch its group fields in one versioned update.
Capability: boards.records.update. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| afterId | input | string or null | no |
| baseVersion | input | integer | yes |
| beforeId | input | string or null | no |
| fields | input | object | no |
| idempotencyKey | input | string | no |
| recordId | input | string | yes |
purgeRecords
Permanently delete trashed records, or empty the trash (recordIds: “all”). Preview first, then commit.
Capability: boards.records.trash. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| recordIds | input | “all” or array |
yes |
| spaceIds | input | array |
no |
restoreRecord
Restore a trashed record at its current version. No preview required.
Capability: boards.records.trash. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| idempotencyKey | input | string | no |
| recordId | input | string | yes |
resolveRecordTitles
Resolve up to 500 recordIds to visible id/title pairs; unreadable records are omitted. No paging.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| recordIds | input | array |
yes |
trashRecord
Move a record to the trash (restorable for 30 days in the cloud). Preview first, then commit.
Capability: boards.records.trash. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| recordId | input | string | yes |
updateRecord
Update some fields of a record. Fields not sent stay as they are.
Capability: boards.records.update. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | no |
| fields | input | object | yes |
| idempotencyKey | input | string | no |
| recordId | input | string | yes |
core
getEmailPreferences
Read my email notification setting (off, batched every 15 minutes, or daily).
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
setEmailPreferences
Change my email notification setting.
Capability: core.self.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| notifications | input | “off” / “batched” / “daily” | yes |
createGrant
Grant a member or team a capability at tenant, space or exact item scope.
Capability: core.grants.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| capability | input | string | yes |
| effect | input | “allow” / “deny” | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| scope | input | { kind: “tenant” } or { kind: “space”, id: string } or { kind: “item”, id: string } | yes |
| subject | input | { kind: “member”, id: string } or { kind: “team”, id: string } | yes |
listGrants
List explicit capability grants in this tenant (owners and admins).
Capability: core.grants.manage. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
revokeGrant
Revoke an explicit grant and require sync clients to re-authorize.
Capability: core.grants.manage. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| grantId | input | string | yes |
| idempotencyKey | input | string | no |
listMyTasks
My readable assigned tasks across tables, filtered and paged in SQL.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| bucket | input | “all” / “today” / “overdue” / “upcoming” / “no_date” / “done_today” | no |
| cursor | input | string | no |
| limit | input | integer | no |
| timeZone | input | string | no |
cancelInvite
Cancel an open invite (its link stops working).
Capability: core.invites.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| inviteId | input | string | yes |
createInvite
Invite someone by email. The UI returns the link once; MCP never returns invite tokens. Emails it when a provider is set.
Capability: core.invites.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| input | string | yes | |
| idempotencyKey | input | string | no |
| locale | input | “en” / “hu” | no |
| role | input | “owner” / “admin” / “member” / “limited” / “guest” | no |
| teamIds | input | array |
no |
| ttlDays | input | integer | no |
listInvites
List invites (pending and expired by default).
Capability: core.invites.manage. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| includeClosed | input | boolean or “true” / “false” | no |
| limit | input | integer | no |
resendInvite
Resend an open invite with a fresh link and expiry (the old link stops working).
Capability: core.invites.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| inviteId | input | string | yes |
| ttlDays | input | integer | no |
createLink
Link an editable source to a readable target.
Capability: core.links.write. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| from | input | { module: string, kind: string, id: string } | yes |
| id | input | string | no |
| rank | input | string | no |
| rel | input | string | no |
| to | input | { module: string, kind: string, id: string } | yes |
listLinks
List outgoing links and backlinks visible now.
Capability: core.links.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| entity | input | { module: string, kind: string, id: string } | yes |
| limit | input | integer | no |
removeLink
Remove a link, keeping both entities.
Capability: core.links.write. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| linkId | input | string | yes |
reorderLink
Set a link’s ordering rank.
Capability: core.links.write. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | no |
| linkId | input | string | yes |
| rank | input | string | yes |
getMyCapabilities
Read your effective tenant capabilities and per-space grants in this workspace.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
listMembers
List the workspace’s members (people and agents) with role, status, teams and last activity.
Capability: core.members.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| includeRemoved | input | boolean or “true” / “false” | no |
| kind | input | “person” / “agent” | no |
| limit | input | integer | no |
| status | input | “invited” / “active” / “suspended” / “removed” | no |
reactivateMember
Reactivate a suspended member.
Capability: core.members.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| memberId | input | string | yes |
removeMember
Remove a member (offboarding): hand their spaces, private items and views to another member, remove their agents and team memberships, end their access.
Capability: core.members.manage. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| idempotencyKey | input | string | no |
| memberId | input | string | yes |
| reassignTo | input | string | no |
suspendMember
Suspend a member: their sessions, keys and agents stop working until reactivated.
Capability: core.members.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| memberId | input | string | yes |
updateMemberRole
Change a member’s role (role ceiling applies; only owners make owners; one owner always stays).
Capability: core.members.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| memberId | input | string | yes |
| role | input | “owner” / “admin” / “member” / “limited” / “guest” or string | yes |
setWorkspaceModule
Enable or hide a workspace module without deleting its data.
Capability: core.modules.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| enabled | input | boolean | yes |
| module | input | “boards” / “notes” / “track” / “files” / “flows” / “send” | yes |
archiveNotifications
Update my currently readable notifications: archive.
Capability: core.self.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| archived | input | boolean | no |
| ids | input | array |
yes |
createNotification
Send a custom inbox notification to up to ten workspace members.
Capability: core.notifications.create. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| memberIds | input | array |
yes |
| message | input | string | yes |
| target | input | { kind: “record” / “table” / “view” / “note”, id: string } | yes |
listMyNotifications
My persisted notifications, rechecked against current target visibility.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| limit | input | integer | no |
| state | input | “active” / “archived” / “all” | no |
| unreadOnly | input | boolean or “true” / “false” | no |
markAllNotificationsRead
Update my currently readable notifications: markAllRead.
Capability: core.self.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
No input fields.
markNotificationsRead
Update my currently readable notifications: markRead.
Capability: core.self.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| ids | input | array |
yes |
| read | input | boolean | no |
snoozeNotifications
Update my currently readable notifications: snooze.
Capability: core.self.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| ids | input | array |
yes |
| until | input | string or null | yes |
countUnreadNotifications
Count currently readable, active, unsnoozed unread notifications.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
listMyRecents
Visible personal recents for records, tables, views and notes, bounded to 50.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| limit | input | integer | no |
touchMyRecent
Remember a readable personal navigation target.
Capability: core.self.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| id | input | string | yes |
| kind | input | “record” / “table” / “view” / “note” | yes |
createRole
Create a custom role with capability patterns and row/field restrictions.
Capability: core.roles.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| capabilities | input | array |
yes |
| fieldRules | input | array<{ tableId: string, fieldId: string, access: “hidden” / “read” / “edit” }> | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| name | input | string | yes |
| recordRules | input | array<{ tableId: string, access: “read” / “edit”, where: array |
no |
deleteRole
Preview and delete a custom role, reassigning every member when in use.
Capability: core.roles.manage. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| idempotencyKey | input | string | no |
| reassignTo | input | “owner” / “admin” / “member” / “limited” / “guest” or string | no |
| roleId | input | string | yes |
listRoles
List the roles: built-in roles with their capabilities, member counts and whether you may assign them.
Capability: core.roles.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
updateRole
Update a custom role. Built-in roles are immutable.
Capability: core.roles.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| capabilities | input | array |
yes |
| fieldRules | input | array<{ tableId: string, fieldId: string, access: “hidden” / “read” / “edit” }> | no |
| idempotencyKey | input | string | no |
| name | input | string | yes |
| recordRules | input | array<{ tableId: string, access: “read” / “edit”, where: array |
no |
| roleId | input | string | yes |
getScriptRun
Read a SRVO Script run you started: status, output or error, CPU and SDK calls.
Capability: core.scripts.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| runId | input | string | yes |
runScript
Start a read-only SRVO Script run as you. Poll core.scripts.get for the result.
Capability: core.scripts.run. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| args | input | unknown | no |
| source | input | string | yes |
searchWorkspace
Search readable records, structure, note titles, member names and own Track entries. Empty queries return no recents.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| limit | input | integer | no |
| q | input | string | yes |
| types | input | array<“record” / “table” / “dashboard” / “space” / “folder” / “view” / “note” / “member” / “time_entry”> or string | no |
whoami
Who am I: workspace, member, role, kind, and for agents the person they act for.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
archiveTaxonomy
Archive or unarchive a Project, Client or Tag. Archived entries keep their links and history but cannot be newly used. Needs Manage.
Capability: core.taxonomies.write. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| archived | input | boolean | yes |
| baseVersion | input | integer | yes |
| id | input | string | yes |
| idempotencyKey | input | string | no |
| kind | input | “project” / “client” / “tag” | yes |
getTaxonomyCapabilities
What you can do now: create this kind, your rights on one entry, and whether you can edit a source. Advisory; writes recheck.
Capability: core.taxonomies.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| id | input | string | no |
| kind | input | “project” / “client” / “tag” | yes |
| source | input | { module: string, kind: string, id: string } | no |
createTaxonomy
Create a Project, Client or Tag. You become its manager; default visibility is members-only (Projects/Clients) or workspace (Tags).
Capability: core.taxonomies.write. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| color | input | “gray” / “red” / “orange” / “amber” / “green” / “teal” / “cyan” / “sky” / “blue” / “indigo” / “purple” / “pink” | no |
| fields | input | object | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| kind | input | “project” / “client” / “tag” | yes |
| name | input | string | yes |
| teamIds | input | array |
no |
| visibility | input | “members” / “workspace” / “team” / “private” | no |
deleteTaxonomy
Move an unreferenced Project, Client or Tag to the trash. Preview lists references; referenced entries must be archived instead. Needs Manage and Delete.
Capability: core.taxonomies.write. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmationToken | input | string | no |
| id | input | string | yes |
| idempotencyKey | input | string | no |
| kind | input | “project” / “client” / “tag” | yes |
getTaxonomy
Read one Project, Client or Tag with creator/editor details and your current rights.
Capability: core.taxonomies.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| id | input | string | yes |
| kind | input | “project” / “client” / “tag” | yes |
listTaxonomyHistory
Paged history of one Project, Client or Tag under your current View and field masks. Access details need Manage.
Capability: core.taxonomies.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| eventTypes | input | array<“create” / “rename” / “fields” / “contribution_added” / “link_added” / “link_removed” / “visibility” / “access” / “access_effect” / “archive” / “unarchive” / “trash” / “restore” / “delete_requested” / “recovery” / “migration_baseline”> | no |
| id | input | string | yes |
| kind | input | “project” / “client” / “tag” | yes |
| limit | input | integer | no |
listTaxonomies
List Projects, Clients or Tags you can view. Filters (Made by me, origin, archive, search) apply after access, before paging.
Capability: core.taxonomies.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| archived | input | “active” / “archived” / “all” | no |
| cursor | input | string | no |
| kind | input | “project” / “client” / “tag” | yes |
| limit | input | integer | no |
| madeByMe | input | boolean | no |
| origin | input | “human” / “ai” / “integration” / “automation” / “import” / “migration” | no |
| query | input | string | no |
listTaxonomyChoices
Choices for a Project, Client or Tag picker. Viewable entries without Use are returned disabled with a reason.
Capability: core.taxonomies.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| archived | input | “active” / “archived” / “all” | no |
| cursor | input | string | no |
| kind | input | “project” / “client” / “tag” | yes |
| limit | input | integer | no |
| madeByMe | input | boolean | no |
| origin | input | “human” / “ai” / “integration” / “automation” / “import” / “migration” | no |
| query | input | string | no |
| source | input | { module: string, kind: string, id: string } | no |
updateTaxonomy
Rename a Project, Client or Tag, change a Tag colour, or edit permitted fields. Needs Manage.
Capability: core.taxonomies.write. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| id | input | string | yes |
| idempotencyKey | input | string | no |
| kind | input | “project” / “client” / “tag” | yes |
| patch | input | { name?: string, color?: “gray” / “red” / “orange” / “amber” / “green” / “teal” / “cyan” / “sky” / “blue” / “indigo” / “purple” / “pink”, fields?: object } | yes |
createTeam
Create a team (open or closed), optionally with its first members.
Capability: core.teams.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| id | input | string | no |
| idempotencyKey | input | string | no |
| memberIds | input | array |
no |
| name | input | string | yes |
| visibility | input | “open” / “closed” | no |
deleteTeam
Delete a team that has no spaces left; its memberships go with it.
Capability: core.teams.manage. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| idempotencyKey | input | string | no |
| teamId | input | string | yes |
listTeams
List teams: open ones, the closed ones you’re in (team managers see all).
Capability: core.teams.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
addTeamMember
Add a member to a team. Without team management rights you can only join an open team yourself.
Capability: core.teams.join. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| memberId | input | string | yes |
| teamId | input | string | yes |
removeTeamMember
Remove a member from a team. Without team management rights you can only leave a team yourself.
Capability: core.teams.join. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| memberId | input | string | yes |
| teamId | input | string | yes |
updateTeam
Rename a team or switch it between open and closed.
Capability: core.teams.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| name | input | string | no |
| teamId | input | string | yes |
| visibility | input | “open” / “closed” | no |
listTrashedRecords
Return readable trashed records under live parents. Pass optional cursor/limit; follow nextCursor. Structure trash uses listTrashedItems.
Capability: core.self.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| limit | input | integer | no |
files
getFileDownloadUrl
Sign a five-minute attachment URL after a current permission check.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fileId | input | string | yes |
| versionId | input | string | no |
copyFile
Copy a readable file into a writable folder using storage-side copy.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fileId | input | string | yes |
| folderId | input | string or null | no |
| spaceId | input | string | yes |
getFile
Get one visible file’s metadata (name, type, size, folder, status, version). Never returns file bytes or URLs.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fileId | input | string | yes |
moveFile
Move a file after checking its folder permission.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmToken | input | string | no |
| fileId | input | string | yes |
| folderId | input | string or null | no |
| spaceId | input | string | yes |
purgeFile
Permanently delete a trashed file (bytes are removed after retention). Call without confirmationToken to preview, then with the returned token to commit.
Capability: files.entries.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmationToken | input | string | no |
| fileId | input | string | yes |
renameFile
Rename a file after checking its folder permission.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| fileId | input | string | yes |
| name | input | string | yes |
restoreFile
Restore a file after checking its folder permission.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmToken | input | string | no |
| fileId | input | string | yes |
trashFile
Trash a file after checking its folder permission.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| fileId | input | string | yes |
createFileFolder
Create a Files folder in the shared item tree.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| name | input | string | yes |
| parentId | input | string or null | no |
| spaceId | input | string | yes |
| visibility | input | “inherit” / “private” | no |
listFiles
List visible folders first, then files, with sorting and paging.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| direction | input | “asc” / “desc” | no |
| folderId | input | string or null | no |
| limit | input | integer | no |
| offset | input | integer | no |
| parentId | input | string or null | no |
| section | input | “all” / “workspace” / “shared” / “private” / “favourites” / “recent” / “sharedWithMe” | no |
| sort | input | “name” / “modified” / “size” | no |
| spaceId | input | string | no |
moveFileFolder
Move a Files folder.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmToken | input | string | no |
| folderId | input | string | yes |
| parentId | input | string or null | yes |
getFilePath
Get the folder path (breadcrumb) from the root to a visible file or folder. Ancestors you cannot see come back with null id and name.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| itemId | input | string | yes |
purgeFileFolder
Permanently delete a trashed Files folder and its contents you can edit (bytes are removed after retention). Call without confirmationToken to preview, then with the returned token to commit.
Capability: files.entries.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmationToken | input | string | no |
| folderId | input | string | yes |
renameFileFolder
Rename a Files folder.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| folderId | input | string | yes |
| name | input | string | yes |
restoreFileFolder
Restore a Files folder.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmToken | input | string | no |
| folderId | input | string | yes |
trashFileFolder
Trash a Files folder.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| folderId | input | string | yes |
getFilePreviewUrl
Sign an allowlisted image/PDF preview; other types download as attachments.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fileId | input | string | yes |
| versionId | input | string | no |
ensureFilesRoot
Create a usable Files root in a writable space, or return the existing root.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| spaceId | input | string | yes |
createFileShare
Create a Transfer package or file request link. Returns the token once.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “restricted” / “workspace” / “anyone” | no |
| disableDownload | input | boolean | no |
| downloadLimit | input | integer | no |
| expiresInDays | input | integer | no |
| fileIds | input | array |
no |
| folderId | input | string or null | no |
| kind | input | “transfer” / “request” | yes |
| message | input | string | no |
| password | input | string | no |
| recipients | input | array |
no |
| role | input | “viewer” / “commenter” / “editor” | no |
| spaceId | input | string or null | no |
| targetItemId | input | string | no |
| title | input | string | no |
getFileShare
Read one of my shares with its view, download and upload history.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| shareId | input | string | yes |
listFileShares
List my Transfer packages and file requests, newest first.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| kind | input | “transfer” / “request” | no |
| limit | input | integer | no |
listItemFileShares
List all live links on an item I can manage.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| targetItemId | input | string | yes |
revokeFileShare
Revoke a share now. The public link stops at once.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| shareId | input | string | yes |
updateFileShare
Update a v2 item link’s audience, role, password, expiry and download setting.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “restricted” / “workspace” / “anyone” | no |
| disableDownload | input | boolean | no |
| expiresInDays | input | integer | no |
| password | input | string or null | no |
| role | input | “viewer” / “commenter” / “editor” | no |
| shareId | input | string | yes |
getFileStorageUsage
Read workspace storage usage, including versions, trash and pending reservations.
Capability: files.storage.manage. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
listTrashedFiles
List trashed Files folders and files you could restore. Paginated with offset and limit (max 200); hasMore says whether another page exists.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| limit | input | integer | no |
| offset | input | integer | no |
abortFileUpload
Abort a direct upload session owned by the caller.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| uploadId | input | string | yes |
beginFileUpload
Reserve storage and sign a direct upload. Never send file bytes to this endpoint.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| collision | input | “rename” / “replace” | no |
| contentType | input | string | yes |
| folderId | input | string or null | no |
| name | input | string | yes |
| sha256 | input | string | no |
| size | input | integer | yes |
| spaceId | input | string | yes |
completeFileUpload
Complete a direct upload session owned by the caller.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| etag | input | string | no |
| uploadId | input | string | yes |
recordFileUploadPart
Part a direct upload session owned by the caller.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| part | input | { n: integer, etag: string, size: integer } | yes |
| uploadId | input | string | yes |
getFileUploadUrls
Urls a direct upload session owned by the caller.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| parts | input | array |
yes |
| uploadId | input | string | yes |
listFileVersions
List a visible file’s retained versions.
Capability: files.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fileId | input | string | yes |
restoreFileVersion
Restore a clean retained version without overwriting its bytes.
Capability: files.entries.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| fileId | input | string | yes |
| versionId | input | string | yes |
flows
createFlow
Create a disabled flow with an immutable version.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| definition | input | { schemaVersion: 1, id: string, version: integer, name: string, trigger: { type: “record”, event: “created” / “updated” / “matching”, tableId: string, filter?: object, fieldId?: string, from?: object, to?: object } or { type: “track”, clientId?: string, projectId?: string } or { type: “schedule”, cron: string, timeZone: string, hungarianHolidays?: “include” / “skip-non-working-days” } or { type: “webhook”, method: “GET” / “POST” / “PUT” / “PATCH” / “DELETE”, payloadSchema: object } or { type: “inbound-email”, connectionId?: string } or { type: “form-submitted”, formId: string } or { type: “manual” } or { type: “flow”, flowId: string }, entry: string, steps: object } | yes |
| idempotencyKey | input | string | no |
| runAs | input | string | no |
disableFlow
disable a flow.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
createFlowEmail
Give an email-triggered flow a new inbound address (replaces the old one). Returns its local part.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
disableFlowEmail
Remove a flow’s inbound email address.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
enableFlow
enable a flow.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
getFlow
Get a flow definition.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
listFlows
List workspace flows.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| trash | input | boolean | no |
restoreFlow
restore a flow.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
clearFlowRuns
Clear terminal run history. Active runs remain.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
getFlowRun
Get a run and its redacted step trace.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| runId | input | string | yes |
listFlowRuns
Page through newest flow runs.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| flowId | input | string | yes |
| limit | input | integer | no |
| status | input | “queued” / “running” / “succeeded” / “failed” / “skipped” / “cancelled” | no |
deleteFlowSecret
Delete a vault secret (owners/admins).
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| name | input | string | yes |
listFlowSecrets
List vault secret names for HTTP steps. Values are never returned.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
setFlowSecret
Create or replace a vault secret (owners/admins). HTTP steps reference it as {{secret.NAME}} and may only send it to the listed https origins.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| idempotencyKey | input | string | no |
| name | input | string | yes |
| origins | input | array |
yes |
| value | input | string | yes |
testFlow
Simulate a definition without writes or run usage.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| definition | input | { schemaVersion: 1, id: string, version: integer, name: string, trigger: { type: “record”, event: “created” / “updated” / “matching”, tableId: string, filter?: object, fieldId?: string, from?: object, to?: object } or { type: “track”, clientId?: string, projectId?: string } or { type: “schedule”, cron: string, timeZone: string, hungarianHolidays?: “include” / “skip-non-working-days” } or { type: “webhook”, method: “GET” / “POST” / “PUT” / “PATCH” / “DELETE”, payloadSchema: object } or { type: “inbound-email”, connectionId?: string } or { type: “form-submitted”, formId: string } or { type: “manual” } or { type: “flow”, flowId: string }, entry: string, steps: object } | yes |
| sample | input | __schema0 | yes |
trashFlow
trash a flow.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
updateFlow
Save a new immutable flow version.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| definition | input | { schemaVersion: 1, id: string, version: integer, name: string, trigger: { type: “record”, event: “created” / “updated” / “matching”, tableId: string, filter?: object, fieldId?: string, from?: object, to?: object } or { type: “track”, clientId?: string, projectId?: string } or { type: “schedule”, cron: string, timeZone: string, hungarianHolidays?: “include” / “skip-non-working-days” } or { type: “webhook”, method: “GET” / “POST” / “PUT” / “PATCH” / “DELETE”, payloadSchema: object } or { type: “inbound-email”, connectionId?: string } or { type: “form-submitted”, formId: string } or { type: “manual” } or { type: “flow”, flowId: string }, entry: string, steps: object } | yes |
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
| runAs | input | string | no |
getFlowUsage
Get this workspace’s monthly run pool.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
listFlowVersions
List immutable flow versions.
Capability: flows.edit. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
createFlowWebhook
create an inbound webhook. Modes: srvo (signed + secret header), github (X-Hub-Signature-256), linear (Linear-Signature, paste Linear’s secret), path (secret token in the URL). Secrets are shown once.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
| mode | input | “srvo” / “github” / “linear” / “path” | no |
| signingSecret | input | string | no |
disableFlowWebhook
disable an inbound webhook.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
rotateFlowWebhook
rotate an inbound webhook. Modes: srvo (signed + secret header), github (X-Hub-Signature-256), linear (Linear-Signature, paste Linear’s secret), path (secret token in the URL). Secrets are shown once.
Capability: flows.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| flowId | input | string | yes |
| idempotencyKey | input | string | no |
| mode | input | “srvo” / “github” / “linear” / “path” | no |
| signingSecret | input | string | no |
import
disconnectImportConnection
Disconnect your source connection and cancel its active runs.
Capability: import.plans.apply. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| connectionId | input | string | yes |
importFromConnection
Start an import using your existing source connection.
Capability: import.plans.apply. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| connectionId | input | string | yes |
listImportConnections
List your source connections without credentials.
Capability: import.plans.apply. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
cancelImportConnector
Stop an own import run and delete its token. Committed rows stay.
Capability: import.plans.apply. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| runId | input | string | yes |
getImportConnector
Get an own import run, its discovery while picking and its plan while ready.
Capability: import.jobs.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| itemId | input | string | no |
| runId | input | string | yes |
pickImportConnector
Choose what to import and where, then fetch it in the background.
Capability: import.plans.apply. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| runId | input | string | yes |
| selection | input | { provider: “airtable”, baseId?: string, bases?: array |
yes |
| spaceId | input | string | no |
| target | input | { kind: “existing”, spaceId: string } or { kind: “section”, audience?: “private” / “workspace”, name?: string } or { kind: “folder”, folderId: string, name?: string } or { kind: “new”, teamId: string, name: string } | no |
retryImportConnectorItem
Retry one failed table without repeating completed tables.
Capability: import.plans.apply. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| itemId | input | string | yes |
| runId | input | string | yes |
startImportConnector
Apply the previewed plan in the background with the reviewed mappings.
Capability: import.plans.apply. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| mappings | input | { tableMappings?: object, fieldMappings?: object } | yes |
| runId | input | string | yes |
previewImportFiles
Preview base64 export files before importing: up to 50 files, 5 MB total and 50,000 rows. Writes no destination data.
Capability: import.plans.apply. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| columns | input | object | no |
| files | input | array<{ name: string, base64: string }> | yes |
| idColumn | input | string | no |
| sheet | input | string | no |
| source | input | “csv” / “xlsx” / “monday” / “nocodb” / “airtable” / “toggl” / “notion” / “trello” / “asana” / “clickup” / “linear” | yes |
| sourceId | input | string | yes |
| spaceId | input | string | no |
| target | input | { kind: “existing”, spaceId: string } or { kind: “section”, audience?: “private” / “workspace”, name?: string } or { kind: “folder”, folderId: string, name?: string } or { kind: “new”, teamId: string, name: string } | no |
| timeZone | input | string | no |
cancelImportJob
Stop an owned import after its last committed batch. Keep imported data.
Capability: import.plans.apply. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| jobId | input | string | yes |
getImportJob
Get an import job and its committed progress.
Capability: import.jobs.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| jobId | input | string | yes |
rollbackImportJob
Trash objects created by an import, in resumable batches.
Capability: import.jobs.rollback. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| jobId | input | string | yes |
applyImportPlan
Preview and apply a reviewed import plan in resumable batches.
Capability: import.plans.apply. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| jobId | input | string | no |
| options | input | { conflictPolicy?: “source_wins”, batchSize?: integer, tableMappings?: object, fieldMappings?: object } | no |
| plan | input | { version: 1, source: “airtable” / “csv” / “nocodb” / “monday” / “notion” / “trello” / “asana” / “clickup” / “linear”, sourceId: string, pages?: array |
no |
| requestId | input | string | no |
| resumeToken | input | string | no |
| target | input | { kind: “existing”, spaceId: string } or { kind: “section”, audience?: “private” / “workspace”, name?: string } or { kind: “folder”, folderId: string, name?: string } or { kind: “new”, teamId: string, name: string } | no |
metrics
queryMetricSeries
Query readable metric series and previous periods with the SRVO Script contract.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| compareTo | input | “previousPeriod” | no |
| filters | input | array<{ field: string, op: “eq” / “neq”, value: string or number or boolean } or { field: string, op: “in”, values: array |
no |
| groupBy | input | array<string or “date:day” / “date:week” / “date:month”> | no |
| metrics | input | array<string or { tableId: string, op: “sum” / “avg” / “min” / “max” / “countRows” / “countNonNull” / “percent”, field?: string, dateField?: string }> | yes |
| range | input | { preset: “thisWeek” / “lastWeek” / “thisMonth” / “lastMonth” } or { lastDays: integer } or { from: string, to: string } | no |
validateMetricQuery
Validate metric tables, fields, units, ranges and access without aggregating.
Capability: boards.records.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| compareTo | input | “previousPeriod” | no |
| filters | input | array<{ field: string, op: “eq” / “neq”, value: string or number or boolean } or { field: string, op: “in”, values: array |
no |
| groupBy | input | array<string or “date:day” / “date:week” / “date:month”> | no |
| metrics | input | array<string or { tableId: string, op: “sum” / “avg” / “min” / “max” / “countRows” / “countNonNull” / “percent”, field?: string, dateField?: string }> | yes |
| range | input | { preset: “thisWeek” / “lastWeek” / “thisMonth” / “lastMonth” } or { lastDays: integer } or { from: string, to: string } | no |
notes
appendNoteParagraph
Append one plain-text paragraph (max 50,000 characters) to the end of a Notes page. Pass the page’s current bodyVersion as baseVersion from getNote; a stale version fails with CONFLICT. Returns the updated page.
Capability: notes.pages.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| pageId | input | string | yes |
| text | input | string | yes |
createNote
Create a Notes page in a space (or under parentId), or a private quick note. Returns the new page. Send an idempotencyKey to make retries safe.
Capability: notes.pages.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| blocks | input | array<{ id: string, type: “heading”, level: 1 or 2 or 3, text: array |
no |
| icon | input | string or null | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| parentId | input | string or null | no |
| private | input | boolean | no |
| quick | input | boolean | no |
| spaceId | input | string | yes |
| title | input | string | yes |
exportNote
Export noteId as safe Markdown. Returns filename, contentType and base64 body over MCP, up to 1 MiB; use REST for larger files.
Capability: notes.pages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| noteId | input | string | yes |
getNote
Read a Notes page and its validated document blocks.
Capability: notes.pages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| noteId | input | string | yes |
listNotes
List visible pages in a space or this member’s quick notes inbox.
Capability: notes.pages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| after | input | string | no |
| limit | input | integer | no |
| quick | input | “true” / “false” | no |
| spaceId | input | string | no |
moveNote
Move a Notes page and its subpages to another space or parent page. Pass the page’s version as baseVersion. Returns the moved page.
Capability: notes.pages.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| pageId | input | string | yes |
| parentId | input | string or null | yes |
| spaceId | input | string | yes |
renameNote
Rename a Notes page. Pass the page’s version as baseVersion; a stale version fails with CONFLICT.
Capability: notes.pages.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| pageId | input | string | yes |
| title | input | string | yes |
restoreNote
Restore a trashed Notes page and its subpages. Call without confirmationToken to preview, then again with the returned token to commit.
Capability: notes.pages.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmationToken | input | string | no |
| pageId | input | string | yes |
saveNote
Replace a Notes page body with the given blocks. Pass the page’s bodyVersion as baseVersion; a stale version fails with CONFLICT. Earlier bodies stay restorable from listNoteVersions. Prefer appendNoteParagraph for small additions.
Capability: notes.pages.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| blocks | input | array<{ id: string, type: “heading”, level: 1 or 2 or 3, text: array |
yes |
| pageId | input | string | yes |
trashNote
Move a Notes page and its subpages to trash. Call without confirmationToken to preview, then again with the returned token to commit.
Capability: notes.pages.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmationToken | input | string | no |
| pageId | input | string | yes |
getNoteVersion
Read one retained version of a visible Notes page.
Capability: notes.pages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| pageId | input | string | yes |
| versionId | input | string | yes |
listNoteVersions
List the retained version metadata of a visible Notes page.
Capability: notes.pages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| pageId | input | string | yes |
restoreNoteVersion
Restore a retained snapshot as a new version, preserving the previous body.
Capability: notes.pages.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| pageId | input | string | yes |
| versionId | input | string | yes |
send
createSendDomain
Add a sending domain. Returns the DNS records to add; a background job checks them.
Capability: send.domains.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| clickTracking | input | boolean | no |
| customReturnPath | input | string | no |
| domain | input | string | yes |
| openTracking | input | boolean | no |
| region | input | “eu-central-1” / “eu-west-1” | no |
| tls | input | “opportunistic” | no |
deleteSendDomain
Remove a sending domain. Its provider identity and DKIM keys are removed in the background.
Capability: send.domains.manage. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| domainId | input | string | yes |
getSendDomain
Read one sending domain with its DNS records and check status.
Capability: send.domains.manage. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| domainId | input | string | yes |
listSendDomains
List sending domains with the DNS records to add and their check status.
Capability: send.domains.manage. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| after | input | string | no |
| before | input | string | no |
| limit | input | integer | no |
updateSendDomain
Change a sending domain’s open/click tracking or TLS setting.
Capability: send.domains.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| clickTracking | input | boolean | no |
| domainId | input | string | yes |
| openTracking | input | boolean | no |
| tls | input | “opportunistic” | no |
verifySendDomain
Ask for a fresh DNS check of a sending domain (runs within a minute).
Capability: send.domains.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| domainId | input | string | yes |
sendBatchEmails
Send up to 100 emails at once (no attachments or scheduling). Strict: all or nothing; permissive: valid ones go out.
Capability: send.emails.send. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| emails | input | array<{ from: string, to: string or array |
yes |
| idempotencyKey | input | string | no |
| validation | input | “strict” / “permissive” | no |
cancelEmail
Cancel a scheduled email before it goes out.
Capability: send.emails.send. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| emailId | input | string | yes |
getEmail
Read one email sent through the API: recipients, subject, last event, and the body while kept.
Capability: send.messages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| emailId | input | string | yes |
listEmails
List emails sent through the API or SMTP, newest first (system mail is never listed).
Capability: send.messages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| after | input | string | no |
| before | input | string | no |
| limit | input | integer | no |
rescheduleEmail
Move a scheduled email to another time (at most 30 days ahead). Only while it is scheduled.
Capability: send.emails.send. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| emailId | input | string | yes |
| scheduledAt | input | string | yes |
sendEmail
Send an email from a verified domain of this workspace (to, cc, bcc ≤ 50, attachments, optional scheduled_at).
Capability: send.emails.send. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| attachments | input | array<{ content?: string, path?: string, filename?: string, contentType?: string, contentId?: string }> | no |
| bcc | input | string or array |
no |
| cc | input | string or array |
no |
| from | input | string | yes |
| headers | input | object | no |
| html | input | string | no |
| idempotencyKey | input | string | no |
| replyTo | input | string or array |
no |
| scheduledAt | input | string | no |
| subject | input | string | yes |
| tags | input | array<{ name: string, value: string }> | no |
| text | input | string | no |
| to | input | string or array |
yes |
sendRawEmail
Send a ready MIME message (the SMTP relay uses this): envelope sender, recipients (≤ 50) and the message as base64. Its From must be on the sender’s verified domain.
Capability: send.emails.send. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| from | input | string | yes |
| idempotencyKey | input | string | no |
| raw | input | string | yes |
| to | input | array |
yes |
listSendMessages
List outbound emails of this workspace, newest first, with delivery status.
Capability: send.messages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| limit | input | integer | no |
| status | input | “queued” / “sent” / “delivered” / “bounced” / “complained” / “failed” / “suppressed” / “blocked” / “scheduled” / “canceled” | no |
getSendStatus
Whether this server has an email provider set up (without one, mail waits in the queue).
Capability: send.messages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
addSuppression
Suppress an email address: mail from this workspace’s Send API skips it from now on.
Capability: send.suppressions.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| input | string | yes | |
| idempotencyKey | input | string | no |
| reason | input | “manual” / “unsubscribe” | no |
addSuppressions
Suppress up to 1,000 email addresses at once. Addresses already listed keep their entry.
Capability: send.suppressions.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| emails | input | array |
yes |
| idempotencyKey | input | string | no |
| reason | input | “manual” / “unsubscribe” | no |
removeSuppressions
Remove up to 1,000 email addresses from the suppression list at once.
Capability: send.suppressions.manage. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| emails | input | array |
yes |
getSuppression
Read one suppression entry by its id or by the email address.
Capability: send.messages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| suppressionId | input | string | yes |
listSuppressions
List the workspace’s suppressed email addresses, newest first (bounces, complaints, manual).
Capability: send.messages.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| after | input | string | no |
| before | input | string | no |
| limit | input | integer | no |
removeSuppression
Remove an address from the suppression list (by id or address). Mail may reach it again, bounces included.
Capability: send.suppressions.manage. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| suppressionId | input | string | yes |
sergio
createSergioConversation
Create a private Sergio conversation
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| scope | input | { kind: “project” / “client”, id: string } | no |
| title | input | string | no |
deleteSergioConversation
Update your private conversation: delete
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| forgetLearned | input | boolean | no |
| id | input | string | yes |
getSergioConversation
Read your conversation and a page of messages
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| id | input | string | yes |
| limit | input | integer | no |
listSergioConversations
List your private Sergio conversations
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| limit | input | integer | no |
| pinned | input | boolean | no |
| query | input | string | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
moveSergioConversation
Update your private conversation: move
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| forgetLearned | input | boolean | no |
| id | input | string | yes |
| scope | input | { kind: “project” / “client”, id: string } or null | yes |
pinSergioConversation
Update your private conversation: pin
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| id | input | string | yes |
| pinned | input | boolean | yes |
renameSergioConversation
Update your private conversation: rename
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| id | input | string | yes |
| title | input | string | yes |
setMemorySergioConversation
Update your private conversation: setMemory
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| id | input | string | yes |
| learn | input | boolean | no |
| use | input | boolean | no |
unpinSergioConversation
Unpin your private Sergio conversation
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| id | input | string | yes |
listExternalSergioChat
Owner-only external coding agent chat list
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| limit | input | integer | no |
| pinned | input | boolean | no |
| query | input | string | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
pollExternalSergioChat
Owner-only external coding agent chat poll
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| id | input | string | yes |
| limit | input | integer | no |
postExternalSergioChat
Owner-only external coding agent chat post
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| id | input | string | yes |
| idempotencyKey | input | string | no |
| text | input | string | yes |
readExternalSergioChat
Owner-only external coding agent chat read
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| id | input | string | yes |
| limit | input | integer | no |
sergioMemoryEntriesCopyToMine
Read or manage Sergio memory under scope and audience policy: entries.copyToMine
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesCreate
Read or manage Sergio memory under scope and audience policy: entries.create
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesForget
Read or manage Sergio memory under scope and audience policy: entries.forget
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesList
Read or manage Sergio memory under scope and audience policy: entries.list
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesPin
Read or manage Sergio memory under scope and audience policy: entries.pin
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesRestore
Read or manage Sergio memory under scope and audience policy: entries.restore
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesShare
Read or manage Sergio memory under scope and audience policy: entries.share
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesUnpin
Read or manage Sergio memory under scope and audience policy: entries.unpin
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryEntriesUpdate
Read or manage Sergio memory under scope and audience policy: entries.update
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryExplain
Read or manage Sergio memory under scope and audience policy: explain
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryGet
Read or manage Sergio memory under scope and audience policy: get
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryHistoryList
Read or manage Sergio memory under scope and audience policy: history.list
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryInstructionsSet
Read or manage Sergio memory under scope and audience policy: instructions.set
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryPause
Read or manage Sergio memory under scope and audience policy: pause
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryReevaluate
Read or manage Sergio memory under scope and audience policy: reevaluate
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryReset
Read or manage Sergio memory under scope and audience policy: reset
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemoryResume
Read or manage Sergio memory under scope and audience policy: resume
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemorySummarySet
Read or manage Sergio memory under scope and audience policy: summary.set
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
sergioMemorySuppressionsClear
Read or manage Sergio memory under scope and audience policy: suppressions.clear
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “shared” / “member” | no |
| baseVersion | input | integer | no |
| confirmed | input | boolean | no |
| conversationId | input | string | no |
| cursor | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| instructions | input | string | no |
| kind | input | “decision” / “fact” / “preference” / “open_item” | no |
| limit | input | integer | no |
| scope | input | { kind: “project” / “client”, id: string } | no |
| sources | input | array<{ source: object, sourceVersion: integer }> | no |
| summary | input | string | no |
| summaryEntries | input | array<{ id: string, version: integer }> | no |
| text | input | string | no |
appendSergioMessage
Append a user message to your private conversation
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fileIds | input | array |
no |
| id | input | string | yes |
| parentMessageId | input | string | no |
| text | input | string | yes |
editSergioMessage
Edit your message: a new version and a fresh answer
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| messageId | input | string | yes |
| text | input | string | yes |
| tier | input | “fast” / “smart” | no |
retrySergioMessage
Answer again: a new version of a Sergio answer
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| messageId | input | string | yes |
| tier | input | “fast” / “smart” | no |
sendSergioMessage
Send a message to Sergio and start streaming the answer
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| fileIds | input | array |
no |
| id | input | string | yes |
| parentMessageId | input | string | no |
| text | input | string | yes |
| tier | input | “fast” / “smart” | no |
| via | input | “text” / “voice” | no |
stopSergioMessage
Stop a streaming Sergio answer
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| messageId | input | string | yes |
decideSergioProposal
Confirm, cancel or undo your Sergio tool proposal using its existing confirmation and undo rules.
Capability: ai.agent.use. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| decision | input | “confirm” / “cancel” / “undo” | yes |
| proposalId | input | string | yes |
getSergioProposal
Read your Sergio tool proposal and its current decision state.
Capability: ai.agent.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| proposalId | input | string | yes |
srvo
getSrvoSettings
Read the workspace SRVO default. Unavailable or narrowed dashboards fall back to Overview.
Capability: srvo.settings.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
setSrvoSettings
Set the workspace SRVO default to a Workspace dashboard or Overview. Human owner/admin only.
Capability: srvo.settings.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| defaultDashboardId | input | string or null | yes |
structure
addDashboardWidget
Add one widget to dashboardId at optional baseVersion. Returns the saved layout; maximum 40 widgets.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | no |
| dashboardId | input | string | yes |
| widget | input | { family?: “metric”, id?: string, kind: “kpi” / “progress” / “bar” / “line” / “stacked” / “table” / “donut”, title?: string, tableId: string, metrics: array |
yes |
createDashboard
Create a dashboard with title and up to 40 widgets. Optional parentId/spaceId controls inherited access; top level is private. Returns the dashboard.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| parentId | input | string or null | no |
| spaceId | input | string | no |
| title | input | string | yes |
| widgets | input | array<{ family?: “metric”, id?: string, kind: “kpi” / “progress” / “bar” / “line” / “stacked” / “table” / “donut”, title?: string, tableId: string, metrics: array |
no |
createDashboardReport
Create a weekly or monthly report dashboard with up to 40 widgets. Optional range defaults to last full period. Returns dashboard and report metadata; no delivery.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cadence | input | “weekly” / “monthly” | yes |
| parentId | input | string or null | no |
| range | input | “all” / “thisWeek” / “lastWeek” / “thisMonth” / “lastMonth” / “last7” / “last30” / “last90” / “last365” | no |
| spaceId | input | string | no |
| title | input | string | yes |
| widgets | input | array<{ family?: “metric”, id?: string, kind: “kpi” / “progress” / “bar” / “line” / “stacked” / “table” / “donut”, title?: string, tableId: string, metrics: array |
yes |
discardDashboard
Move a dashboard created by Sergio to the trash while its widgets are unchanged (Undo).
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| dashboardId | input | string | yes |
editDashboardWidgets
Add, update or remove dashboard widgets by dashboardId and optional baseVersion. Returns the saved layout; maximum 40 widgets.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| add | input | array<{ family?: “metric”, id?: string, kind: “kpi” / “progress” / “bar” / “line” / “stacked” / “table” / “donut”, title?: string, tableId: string, metrics: array |
no |
| baseVersion | input | integer | no |
| dashboardId | input | string | yes |
| remove | input | array |
no |
| update | input | array<{ family?: “metric”, id: string, kind: “kpi” / “progress” / “bar” / “line” / “stacked” / “table” / “donut”, title?: string, tableId: string, metrics: array |
no |
getDashboard
Read a dashboard’s saved widgets (the ones on tables the caller can see) and its version.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| dashboardId | input | string | yes |
saveDashboard
Replace a dashboard’s widgets (max 40; family metric, module or script). Send the version you read as baseVersion; a newer save returns CONFLICT.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| dashboardId | input | string | yes |
| widgets | input | array<{ family?: “metric”, id: string, kind: “kpi” / “progress” / “bar” / “line” / “stacked” / “table” / “donut”, title?: string, tableId: string, metrics: array |
yes |
addFavourite
Add an item to the caller’s favourites (last).
Capability: structure.favourites.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| itemId | input | string | yes |
removeFavourite
Remove an item from the caller’s favourites.
Capability: structure.favourites.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| itemId | input | string | yes |
addViewFavourite
Favourite a visible view for this member.
Capability: structure.favourites.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| viewId | input | string | yes |
removeViewFavourite
Remove a personal view favourite.
Capability: structure.favourites.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| viewId | input | string | yes |
convertField
Change a field’s type and convert every value. Preview shows how many values convert, need review or are lost; then commit.
Capability: structure.fields.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| config | input | object | no |
| confirmationToken | input | string | no |
| fid | input | string | yes |
| tableId | input | string | yes |
| type | input | “title” / “text” / “long_text” / “number” / “currency” / “select” / “multi_select” / “status” / “checkbox” / “date” / “duration” / “person” / “files” / “url” / “email” / “phone” / “rating” / “progress” / “auto_number” / “created_time” / “updated_time” / “created_by” / “updated_by” / “link” / “subtasks” / “note” / “lookup” / “rollup” / “formula” / “time_tracked” / “estimate” | yes |
createField
Add a field to a table. Config is validated per type; formulas are type-checked.
Capability: structure.fields.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| beforeFid | input | string or null | no |
| config | input | object | no |
| description | input | string or null | no |
| fid | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| name | input | string | yes |
| required | input | boolean | no |
| tableId | input | string | yes |
| type | input | “title” / “text” / “long_text” / “number” / “currency” / “select” / “multi_select” / “status” / “checkbox” / “date” / “duration” / “person” / “files” / “url” / “email” / “phone” / “rating” / “progress” / “auto_number” / “created_time” / “updated_time” / “created_by” / “updated_by” / “link” / “subtasks” / “note” / “lookup” / “rollup” / “formula” / “time_tracked” / “estimate” | yes |
trashField
Move a field to the trash (its values stay in the records). Preview first, then commit.
Capability: structure.fields.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| fid | input | string | yes |
| tableId | input | string | yes |
listFields
The fields of a table, in order (fields hidden from the caller are left out).
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| tableId | input | string | yes |
updateField
Rename a field, edit its description, required flag, order or same-type config.
Capability: structure.fields.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| beforeFid | input | string or null | no |
| config | input | object | no |
| description | input | string or null | no |
| fid | input | string | yes |
| name | input | string | no |
| required | input | boolean | no |
| tableId | input | string | yes |
createForm
Create a form on a Boards table. Each question maps to one table field. Returns the form, unpublished. Send an idempotencyKey to make retries safe.
Capability: structure.views.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| definition | input | { title: string, description?: string, questions: array |
yes |
| id | input | string | no |
| idempotencyKey | input | string | no |
| tableId | input | string | yes |
getForm
Get one form’s definition: title, questions and their board fields, and publish state. Forms that use a field hidden from you return NOT_FOUND.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| formId | input | string | yes |
listForms
List the forms of one Boards table (tableId) that you can read, with their definitions. Not paginated.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| tableId | input | string | yes |
| trash | input | boolean or “true” / “false” | no |
publishForm
Publish a form so its public link accepts submissions, which are saved as records under your authority.
Capability: structure.views.edit. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: true.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| formId | input | string | yes |
| idempotencyKey | input | string | no |
restoreForm
Restore a form as an unpublished draft.
Capability: structure.views.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmationToken | input | string | no |
| formId | input | string | yes |
| idempotencyKey | input | string | no |
listFormSubmissions
List a form’s submissions as record ids and submit times, in a stable order. Only records you can read are returned, so a page may hold fewer than limit; read each with getRecord. Paginated: pass next as after until it is null.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| after | input | string | no |
| formId | input | string | yes |
| limit | input | integer | no |
trashForm
Move a form to trash and disable its public link.
Capability: structure.views.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmationToken | input | string | no |
| formId | input | string | yes |
| idempotencyKey | input | string | no |
unpublishForm
Unpublish a form so its public link stops accepting submissions.
Capability: structure.views.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| formId | input | string | yes |
| idempotencyKey | input | string | no |
updateForm
Replace a form’s definition. Pass the form’s version as baseVersion. A published form is unpublished and must be published again.
Capability: structure.views.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| definition | input | { title: string, description?: string, questions: array |
yes |
| formId | input | string | yes |
| idempotencyKey | input | string | no |
createItem
Create a folder, table, page, dashboard or form in a space. Tables get their primary Title field.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “private” / “workspace” | no |
| beforeId | input | string or null | no |
| icon | input | string or null | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| kind | input | “folder” / “table” / “page” / “dashboard” / “form” | yes |
| module | input | “boards” / “notes” / “files” / “srvo” | no |
| parentId | input | string or null | no |
| private | input | boolean | no |
| spaceId | input | string | no |
| title | input | string | yes |
| workspaceRole | input | “viewer” / “commenter” / “editor” / “owner” | no |
moveItem
Move an item (with everything under it) to another parent or space.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| beforeId | input | string or null | no |
| confirmToken | input | string | no |
| itemId | input | string | yes |
| parentId | input | string or null | yes |
| spaceId | input | string | no |
reorderItem
Put an item before a sibling (beforeId) or last (null).
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| beforeId | input | string or null | yes |
| itemId | input | string | yes |
restoreItem
Restore a trashed item and its contents. Preview first, then confirm.
Capability: structure.items.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| itemId | input | string | yes |
getItemSharing
Who can open an item and why: owner, people, teams, clients, workspace, inherited folders.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| itemId | input | string | yes |
setItemSharing
Share an item with people, teams, clients or the whole workspace, or change or remove access.
Capability: structure.items.share. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| add | input | array<{ subject: object, role: “viewer” / “commenter” / “editor” / “owner” }> | no |
| baseVersion | input | integer | yes |
| confirmToken | input | string | no |
| itemId | input | string | yes |
| notify | input | { message?: string } | no |
| remove | input | array |
no |
| update | input | array<{ grantId: string, role: “viewer” / “commenter” / “editor” / “owner” }> | no |
| workspace | input | “viewer” / “commenter” / “editor” / “owner” or null | no |
transferItemOwnership
Make another workspace member the owner of an item; the previous owner keeps edit access.
Capability: structure.items.share. Kind: write. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| confirmToken | input | string | no |
| itemId | input | string | yes |
| toMemberId | input | string | yes |
trashItem
Move an item and everything under it to the trash (restorable for 30 days). Preview first, then commit.
Capability: structure.items.edit. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| itemId | input | string | yes |
listTrashedItems
Items in the trash the caller can see (newest first).
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| module | input | “boards” / “notes” / “files” / “srvo” | no |
updateItem
Rename an item or change its icon.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| icon | input | string or null | no |
| itemId | input | string | yes |
| title | input | string | no |
listRecents
Visible personal recents, newest first. At most 100 entries retained for 90 days.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| limit | input | integer | no |
touchRecent
Remember a visible item for this member, pruning old and excess recents.
Capability: structure.tree.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| itemId | input | string | yes |
createSpace
Create a space in a team (admins).
Capability: structure.spaces.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| color | input | string | no |
| icon | input | string or null | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| name | input | string | yes |
| teamId | input | string | yes |
moveSpace
Move a space to another team. Preview lists members gaining or losing access.
Capability: structure.spaces.manage. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| spaceId | input | string | yes |
| teamId | input | string | yes |
restoreSpace
Restore a space within 30 days, keeping prior child trash states.
Capability: structure.spaces.manage. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| spaceId | input | string | yes |
trashSpace
Trash a space and its contents for 30 days. Preview first.
Capability: structure.spaces.manage. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| spaceId | input | string | yes |
listTrashedSpaces
List trashed spaces for space managers.
Capability: structure.spaces.manage. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| module | input | “boards” / “notes” / “files” / “srvo” | no |
updateSpace
Rename, re-icon, recolour or reorder a space (admins).
Capability: structure.spaces.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| beforeId | input | string or null | no |
| color | input | string or null | no |
| icon | input | string or null | no |
| name | input | string | no |
| spaceId | input | string | yes |
createTable
Create a Boards table with its fields and views in one step (one undo). Start from a template (structure.templates.list) or pass fields and views. Private by default.
Capability: structure.items.edit. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| audience | input | “private” / “workspace” | no |
| fields | input | array<{ fid?: string, name: string, type: “text” / “long_text” / “number” / “currency” / “select” / “multi_select” / “status” / “checkbox” / “date” / “duration” / “person” / “files” / “url” / “email” / “phone” / “rating” / “progress” / “auto_number” / “created_time” / “updated_time” / “created_by” / “updated_by” / “link” / “subtasks” / “note” / “lookup” / “rollup” / “formula” / “time_tracked” / “estimate”, config?: object }> | no |
| icon | input | string or null | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| parentId | input | string or null | no |
| primaryName | input | string | no |
| spaceId | input | string | yes |
| templateId | input | “blank” / “projects” / “finances” / “todos” / “calendar” / “clients” | no |
| title | input | string | yes |
| views | input | array<{ type: “table” / “list” / “kanban” / “calendar” / “timeline” / “report” / “gallery” / “workload” / “mind_map” / “pivot” / “canvas”, name: string, config?: object }> | no |
listBoardTemplates
Board starting points (Blank, Projects, Finances, To-dos, Calendar / Events, Clients) with their fields and first view, for structure.tables.create.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
getTree
The sidebar tree: spaces, items and the caller’s favourites, as far as the caller can see.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| module | input | “boards” / “notes” / “files” / “srvo” | no |
createView
Save a new view of a table (shared, or personal with personal: true). Also how to copy a locked view.
Capability: structure.views.personal. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| beforeId | input | string or null | no |
| config | input | { filter?: __schema0 or null, sorts?: array |
no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| locked | input | boolean | no |
| name | input | string | yes |
| personal | input | boolean | no |
| tableId | input | string | yes |
| type | input | “table” / “list” / “kanban” / “calendar” / “timeline” / “report” / “gallery” / “workload” / “mind_map” / “pivot” / “canvas” | yes |
deleteView
Delete a view (moves it to the trash; records are not touched).
Capability: structure.views.personal. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| viewId | input | string | yes |
listViews
The saved views of a table: shared ones plus the caller’s personal ones, in order.
Capability: structure.tree.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| tableId | input | string | yes |
reorderView
Put a view before another (beforeId) or last (null). Locked views follow the lock rules.
Capability: structure.views.personal. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| beforeId | input | string or null | yes |
| viewId | input | string | yes |
setViewSelectionStats
Save which statistics the caller sees for a selection in this view (per person; locks don’t apply).
Capability: structure.views.personal. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| stats | input | array<“count” / “sum” / “avg” / “min” / “max”> | yes |
| viewId | input | string | yes |
updateView
Change a view’s name, config (merged key by key) or lock. Locked views: only admins or their creator with the lock right; others save a copy.
Capability: structure.views.personal. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| config | input | { filter?: __schema0 or null, sorts?: array |
no |
| locked | input | boolean | no |
| name | input | string | no |
| viewId | input | string | yes |
support
sendFeedback
Send feedback to SRVO support
Capability: core.self.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| errorId | input | string | no |
| includeTechnicalDetails | input | boolean | no |
| kind | input | “bug” / “idea” / “praise” | yes |
| message | input | string | yes |
| technicalDetails | input | { route?: string, release?: string, device?: { browser?: “chrome” / “safari” / “firefox” / “edge” / “other”, os?: “ios” / “macos” / “windows” / “android” / “linux” / “other”, type?: “phone” / “tablet” / “desktop” / “other” }, errors?: array |
no |
track
createTimeEntry
Create a completed manual time entry. Overlaps are allowed.
Capability: track.entries.create. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| billable | input | boolean | no |
| clientRecordId | input | string or null | no |
| description | input | string | no |
| endAt | input | string | yes |
| id | input | string | no |
| idempotencyKey | input | string | no |
| memberId | input | string | no |
| mentionedMemberIds | input | array |
no |
| note | input | string | no |
| projectRecordId | input | string or null | no |
| recordId | input | string or null | no |
| startAt | input | string | yes |
| tagIds | input | array |
no |
| timeZone | input | string | yes |
trashTrackEntries
Move time entries to trash. Preview and confirm the exact versions.
Capability: track.entries.delete. Kind: destructive. readOnlyHint: false. destructiveHint: true. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| confirmationToken | input | string | no |
| entryIds | input | array |
yes |
| expectedVersions | input | object | no |
| idempotencyKey | input | string | no |
exportTrackEntries
Export own or permitted member/team time for the input date range with current rates and rounding. Returns filename, contentType and base64 body over MCP, up to 1 MiB; use REST for larger files. No paging.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| billable | input | “yes” / “no” | no |
| clientId | input | string | no |
| entryIds | input | array |
no |
| format | input | “csv” / “xlsx” | no |
| from | input | string | yes |
| hours | input | “raw” / “rounded” / “both” | no |
| invoiced | input | “yes” / “no” | no |
| locale | input | “en” / “hu” | no |
| memberId | input | string | no |
| notes | input | “yes” / “no” | no |
| projectId | input | string | no |
| rounding | input | “rule” / “off” / “entry” / “report” | no |
| scope | input | “own” / “accessible” | no |
| tagId | input | string | no |
| teamId | input | string | no |
| timeZone | input | string | yes |
| to | input | string | yes |
getTimeEntry
Get a visible time entry.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| entryId | input | string | yes |
| includeDeleted | input | boolean or “true” / “false” | no |
listTimeEntries
List own time or explicitly permitted member/team time intersecting a UTC range.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| cursor | input | string | no |
| from | input | string | yes |
| limit | input | integer | no |
| memberId | input | string | no |
| scope | input | “own” / “accessible” | no |
| teamId | input | string | no |
| timeZone | input | string | yes |
| to | input | string | yes |
mentionTrackEntry
Invite memberIds to copy your confirmed entryId. Returns invitations; recipients keep independently editable copies. People only.
Capability: track.entries.update. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| entryId | input | string | yes |
| idempotencyKey | input | string | no |
| memberIds | input | array |
yes |
restoreTrackEntry
Restore a trashed entry by entryId and baseVersion. Returns the restored entry and changeId. People only.
Capability: track.entries.restore. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| entryId | input | string | yes |
| idempotencyKey | input | string | no |
summarizeTimeEntries
Day/week and project/client totals in an explicit time zone. Drafts excluded; overlaps count independently.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| from | input | string | yes |
| memberId | input | string | no |
| rounding | input | { mode?: “off” / “up” / “down” / “nearest”, stepS?: integer, apply?: “entry” / “report” } | no |
| scope | input | “own” / “accessible” | no |
| teamId | input | string | no |
| timeZone | input | string | yes |
| to | input | string | yes |
updateTimeEntry
Update a time entry at baseVersion. Completed entries cannot become timers.
Capability: track.entries.update. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| entryId | input | string | yes |
| idempotencyKey | input | string | no |
| mentionedMemberIds | input | array |
no |
| patch | input | { description?: string, recordId?: string or null, projectRecordId?: string or null, clientRecordId?: string or null, tagIds?: array |
yes |
acceptTrackMention
Accept your invitation once and create your independently editable time entry.
Capability: track.entries.create. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| mentionId | input | string | yes |
declineTrackMention
Decline your Track invitation.
Capability: track.entries.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| mentionId | input | string | yes |
listTrackMentionPeople
Return all eligible active colleague id/name pairs in this workspace. No paging. People only.
Capability: track.entries.update. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
listTrackPickers
Read permitted Boards clients and projects for Track pickers.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
getTrackPreferences
Return your saved Track view and calendar range. No inputs or paging. People only.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
updateTrackPreferences
Save your Track view and calendar range patch. Returns your saved preferences. People only.
Capability: track.entries.read. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| calendarRange | input | 1 or 5 or 7 or “month” | no |
| idempotencyKey | input | string | no |
| view | input | “calendar” / “list” / “timesheet” | no |
getTrackSettings
Read applicable Track settings. Other members’ rates and costs are excluded.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
updateTrackSettings
Save workspace Track settings at baseVersion. Returns settings and changeId. Human owner/admin only; stale versions fail.
Capability: track.settings.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| idempotencyKey | input | string | no |
| settings | input | { rates: array |
yes |
archiveTrackTag
Set tagId archived state without changing historical entries. Returns tag and changeId. Human owner/admin only.
Capability: track.settings.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| archived | input | boolean | no |
| baseVersion | input | integer | yes |
| idempotencyKey | input | string | no |
| tagId | input | string | yes |
createTrackTag
Create a Track tag from name and palette color. Returns tag and changeId. Human owner/admin only.
Capability: track.settings.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| color | input | “gray” / “red” / “orange” / “amber” / “green” / “teal” / “cyan” / “sky” / “blue” / “indigo” / “purple” / “pink” | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| name | input | string | yes |
listTrackTags
List the Track tag catalogue, including archived tags for history.
Capability: track.entries.read. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
renameTrackTag
Update tagId name and optional palette color. Returns tag and changeId. Human owner/admin only.
Capability: track.settings.manage. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | yes |
| color | input | “gray” / “red” / “orange” / “amber” / “green” / “teal” / “cyan” / “sky” / “blue” / “indigo” / “purple” / “pink” | no |
| idempotencyKey | input | string | no |
| name | input | string | yes |
| tagId | input | string | yes |
continueTimer
Stop your running timer and continue entryId atomically. Returns the current entry and stoppedEntry. People only.
Capability: track.timer.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| entryId | input | string | yes |
| idempotencyKey | input | string | no |
getCurrentTimer
Read your running timer, or null when none is running.
Capability: track.timer.use. Kind: read. readOnlyHint: true. destructiveHint: false. openWorldHint: false.
No input fields.
startTimer
Start a timer for yourself (agents start it for their person, as a draft).
Capability: track.timer.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| billable | input | boolean | no |
| clientRecordId | input | string or null | no |
| description | input | string | no |
| id | input | string | no |
| idempotencyKey | input | string | no |
| mentionedMemberIds | input | array |
no |
| note | input | string | no |
| projectRecordId | input | string or null | no |
| recordId | input | string | no |
| startAt | input | string | no |
| tagIds | input | array |
no |
| timeZone | input | string | no |
stopTimer
Stop your running timer.
Capability: track.timer.use. Kind: write. readOnlyHint: false. destructiveHint: false. openWorldHint: false.
| Field | In | Type | Required |
|---|---|---|---|
| baseVersion | input | integer | no |
| endAt | input | string | no |
| entryId | input | string | no |
| idempotencyKey | input | string | no |