Query Object
Fields
#
actionLinks
Lists dependency edges involving specified actions; include the focal action and known neighbors. source is the predecessor that blocks, target is the dependent successor. type is 0 for finish-to-start, 1 start-to-start, 2 finish-to-finish, or 3 start-to-finish. Inaccessible actions and links are omitted; use getActions for fuller action details.
getActionViewByProjectId
This query is used to get the action view by project id.
getAction
Get an action by ID Access: Requires user access to the action Parameters:
- actionId: The ID of the action to retrieve Returns: The requested action
getActionByWorkspace
Get an action by ID/simpleId and workspaceId
Access: Requires user access to the action
Parameters:
- actionId: The ID or simpleId of the action to retrieve
- workspaceId: The ID of the workspace to retrieve the action from.
Returns: The requested action
getProjectActions
List one project's primary actions in projectId-descending/_id-descending order. Excludes deleted and archived actions; includes completed actions. Caller access remains authoritative. Set both visibility options true to include draft and hidden future recurring rows for migration parity. For source recipes limited to their first 200 records, use one page without after. Errors: Workspace/project access, invalid page size, or invalid/out-of-scope cursor.
getActionsByWorkspace
Returns a paginated list of actions by workspaceId and ID/simpleId
actionHistory
List audit history for an action, including event type and actor metadata. Access: Requires access to the action.
getActionHighwayRunSteps
Read a page of the action's stored Highway run steps in append order. Access: Requires the admin and highway-admin roles, a secure VPN or trusted Highway runtime, and access to the action. Errors: Rejects unauthorized callers, invalid pagination, or a run ID that no longer owns the action's history.
activityFeeds
Lists the caller's Hive notifications across accessible workspaces, newest first. isRead filters archive state: use false for the active inbox, true for archived items, or omit only when both are wanted. isOpened filters opened state; bucket filters inbox type.
getAppWorkflowRuns
Lists non-deleted workflow runs newest first, including running, completed, failed, skipped and cancelled root and child runs. Equal creation timestamps are ordered by run ID. Retrieve operation errors and warnings, Buzz thread IDs, scheduled occurrence, lineage and candidate skip summaries by workflow ID. Errors, warnings and candidate summaries require workflow creator/owner or workspace admin access. Legacy records have null optional diagnostics. Access: authenticated internal members of the workflow's workspace. Errors: not logged in, no workspace access, workflow not found, invalid cursor, or page size outside 1–100.
getLatestAppWorkflowRun
Returns the newest non-deleted run for a workflow in the requested workspace. Returns null when the workflow does not exist in that workspace or has no runs yet. Sensitive run details (API request payload and operation input, output, error, skip reason, and warning) are visible only to the workflow creator or workspace admins; other users receive null. Access: Any authenticated member of the requested workspace. Errors:
- "User is not logged in" if no user session.
- "User does not have access to workspace" if the user is not a member of the requested workspace.
getAiIntakeAssessmentWorkflow
Returns the Hive-managed AI intake assessment workflow for this workspace. The workflow is provisioned disabled on first access. Access:
- Workspace admins only. Errors:
- "User is not logged in" if no user session.
- "User does not have access to workspace" if the user is not a workspace member.
- "Only workspace admins can manage AI intake assessment" if the user is not an admin.
getAppWorkflowsByWorkspace
Lists app workflows in a workspace the caller can access.
getBuzzAutomationHandoffPreview
Preview a Buzz automation handoff without writing: validates it exactly like transferBuzzAutomationOwner and returns what would move. Same access rules and errors.
approvalRounds
Retrieve all approval rounds for a specific action. Returns a paginated list of approval rounds. Use this to view existing approval rounds on an action before modifying stages or approvers.
currentRoundAndStage
Gets an action's active approval round and stage, including each approver's status. Returns null when no accessible approval stage is awaiting a decision.
nextApprovalStage
Gets the next approval stage awaiting a decision for an action, including approver identities and statuses. Returns null when no accessible stage is pending.
approvalStages
Retrieve all approval stages for a specific approval round. Returns a paginated list of stages. Use this to view existing stages in a round before modifying approvers or stage settings.
getApprovalTemplates
List all available approval templates in a workspace. Use this to discover which approval templates can be applied to actions. Templates provide pre-configured approval workflows with stages and approvers that can be reused across multiple actions.
aiProofingLearnedInstructions
Lists Proofing instructions in exactly one scope. Omit projectId for workspace scope. Includes candidates and suppressed preferences for management. Newest-modified first.
Access: workspace members (external users excluded).
buzzAiUsage
Aggregates Buzz token usage from ClickHouse buzzTokenUsageHourlyStats for
Hive HQ operators. Scope filters narrow which
workspaces/users/features/models/origins/environments are included.
Access: super admin with Hive HQ workspace membership.
getBuzzCommands
Get slash commands for a workspace. Can filter by specific IDs or search by name prefix.
getBuzzMessages
Full message transcript for one Buzz thread, oldest first, including the assistant's answers and the tool calls and tool results behind them. This is how a caller reads what Buzz did after an asynchronous mutation such as continueCustomAppAuthoring returned: poll until an assistant message newer than the turn you sent appears. Access: authenticated member of the thread's workspace. Errors: inaccessible thread.
getThreadSummary
Returns the most recent thread summary message, or null if none exists.
getBuzzMessageToolResult
Rehydrates the full stored tool result output for a historical function_call_result. Typically used after context compaction. Requires matching messageId and callId and enforces thread access.
getBuzzSnippets
Get deterministic Buzz snippets available in a workspace.
getBuzzSnippetVersion
Get one snippet version by versionId. versionId must be a BuzzSnippetVersion _id, not the snippet name. If only a snippet name is known, call getBuzzSnippets with search first, then use latestVersionId for editing; normal runs pass the snippet _id to runBuzzSnippetVersion, which resolves the published version itself. Buzz should inspect inputSchema/outputSchema before running it.
getBuzzSnippetSource
Read or search a bounded range of a snippet's exact saved JavaScript. Access: same as viewing the version, with editor access required for drafts. Errors: inaccessible version or invalid range. For edits, resolve latestVersionId with getBuzzSnippets, search for the affected code, and pass versionId/codeHash to editBuzzSnippetDraft. Offsets count JavaScript string characters (UTF-16). Ranges can be fetched again after context compaction; search starts near the first exact occurrence.
getBuzzSnippetSampleInput
Generate sample input matching a snippet version's inputSchema for testing. ID-like fields (actionId, projectId, userId, labelId, ...) are resolved to real records the current user can access in the snippet's workspace; kinds with no accessible record fall back to format-valid random ids.
getBuzzSnippetExternalConnections
List HTTP connections and MCP servers the current user can attach to Buzz snippets. If no suitable connection exists, research whether MCP or HTTP is the right integration path, recommend one setup option with service docs links, and wait for user confirmation before creating it.
getMcpServerTools
List live tools exposed by an accessible MCP server so Buzz can test and shape snippet calls.
getBuzzSnippetRun
Poll a Buzz snippet run by runId (from runBuzzSnippetVersion / dryRunBuzzSnippetVersion). Use while a run is in progress or after wait resumes with buzz_snippet_run.
getBuzzSnippetErrorLogs
List failed and timed-out production snippet runs the current user can access. Each row exposes first-class input (schema + value) and response (schema + result) for audit.
getBuzzThread
Metadata for one Buzz thread — status, title, and last activity — without its messages. status reports whether the agent run is still going: unstarted or inProgress means a reply is still coming, completed or failed means it is done. Use getBuzzMessages for the transcript. Access: authenticated member of the thread's workspace. Errors: inaccessible thread.
getBuzzThreadsByUser
Lists the current user's Buzz threads for a workspace (plus portable solo threads from other workspaces). Defaults to the Active history preset (non-archived, includes waiting status, excludes workflow and campaign origins) and sorts by lastMessageAt descending. Optional status overrides the default status filter only. Optional lastMessageAfter / lastMessageBefore filter on lastMessageAt (inclusive).
getCustomApps
App Studio workspaces only. List Custom Apps available to the current user in one workspace. Access: authenticated workspace member; results include owned, editable, directly shared, and workspace-wide apps. Errors: unavailable environment, unauthenticated user, or inaccessible workspace.
getCustomApp
App Studio workspaces only. Get one available Custom App. Access: authenticated owner, editor, selected recipient, or workspace member for workspace-wide apps. Errors: unavailable environment, Custom App not found, or inaccessible workspace.
getCustomAppVersion
App Studio workspaces only. Get one immutable Custom App version. Access: owner and editors can read any version; recipients can read only the published version. Errors: unavailable environment, version not found, or inaccessible workspace.
getCustomAppVersions
App Studio workspaces only. List an editable Custom App's immutable versions, newest first. Access: authenticated owner or editor. Errors: unavailable environment, Custom App not found, or inaccessible workspace.
getCustomAppVersionSource
App Studio workspaces only. Read the source compiled into one immutable Custom App version. Access: authenticated owner or editor. Errors: unavailable environment, version not found, inaccessible workspace, artifact storage unavailable, or source that no longer matches its persisted hash.
getHivePulseActivity
Returns a privacy-safe sample of recent analytics events across customer workspaces, regardless of event name. At most 200 source events are sampled; this is not a total activity count. Access: full, non-external Hive HQ members only. Errors: status is viewer_not_allowed or backend_unavailable when activity cannot be read.
getCustomFields
Lists custom fields for a workspace, form, or project action view. Supports item type, action type, removal state, text, sorting, and cursor-pagination filters.
getDashboards
Retrieves a paginated list of dashboards with filtering and sorting
getExternalDashboardData
Executes an ExternalData widget's live data contract. HTTP connection requests authenticate with the connection's own credentials (its stored headers/session or its owner's OAuth token); the Hive workspace dataset stays scoped to the widget creator.
getDashboardWidgetOptions
Lists what a chart or pivot widget of one report and type may use, by the chart builder's rules: pivot rows and columns, measures with their aggregations and chart X axes, and filters with their selectedFilters keys. Read it before creating or changing a chart or pivot, and take every XAxis, groupBy, YAxis, aggFunc and pivotTableColumns ID from it.
getDashboardWidgetData
Fetches computed live data for chart-builder dashboard widgets (bar, pie, line, numbers, pivot). Also reads configured Buzz AI Time widgets through Report on Time, using the caller's source permissions. Time measures include tracked/billable/nonbillable hours, estimates, timesheets, approvals/leave, resourcing, capacity, holidays, utilization, rates, costs, budgets and margins. Sources remain separate measures; do not add tracked time to timesheet time. Respect returned units, currency, scope and warnings. Time output is viewer-specific, capped at 200 grouped rows, with no raw data. Access: authenticated workspace member with widget access and the underlying report permissions. Errors: inaccessible widget/workspace, unavailable source or metric permission. Returns normalized values plus an optional raw data payload. Use getDashboardWidgets to obtain widgetId and widget type.
getDashboardWidgets
Retrieves all widgets associated with a specific dashboard. Common use cases:
- Loading a dashboard's initial state
- Refreshing dashboard content
- Exporting dashboard configuration
getMyHomeScratchPad
Reads signed-in user's My Home Scratch Pad in a workspace as Slate rich text. Access: workspace member and owner of the private Home Overview dashboard. Errors: missing Home view, Scratch Pad, or workspace access.
getFileLibraryUploadStatus
Returns current status for protocol-created File Library files. Use this to recover uncertain completion or read confirmation; it does not advance a client-owned binary upload. Access: Authenticated members with access to the workspace and files. Errors: Throws when workspace or file access is denied.
getLatestFileByVersionedFileId
Resolve an action's proofingVersionedFileId to its latest visible file. Use thumbnailLink for a preview and the returned _id as proofingFileId to open Hive's proof viewer. Access: viewers authorized for the versioned file; App Studio calls are limited to the bound workspace. Errors: deleted files are rejected unless includeDeleted is true.
getFileStoreNodes
Paginated File Library listing.
- specificIds: fetch known nodes by ID; preserves input order
- parentId: list direct folder children; pass null for the workspace root, omit for all folders
- search: workspace-wide name search when parentId is omitted; parent-scoped search when parentId is set
- nodeType: optional file/folder filters
getFileLibraryActivity
Paginated File Library activity. Use resourceId/resourceType for a single file or folder, or specificIds to fetch known activity events by ID.
getProjectAiProofingGuidelineNodes
Lists File Library files and folders added as AI proofing guidelines on a project, plus those inherited from its ancestor projects (inherited: true). Access: requires access to the project and matching workspace.
getProjectAiProofingGuidelineDocuments
Lists the files that act as project AI proofing guidelines (own and inherited), expanding guideline folders into their nested File Library files. Access: requires access to the project and matching workspace.
getApplicableProofingGuidelines
Every reference document an AI review may use: the workspace list and, with projectId, the project's account guidelines and project guidelines, each with its source. Access: requires workspace access and access to the requested action/project. Microsoft folders are resolved with the designating user's connected account. Use the returned file IDs as the explicit guideline selection for this action's AI review.
getFormEditHistory
Saved configuration changes for a form and its drafts, newest first. Access: Authenticated workspace members who may edit the form. Errors: Missing form, insufficient access, or an invalid page size or cursor.
getForm
Get a single form by id, including its full jsonFormData definition. Access: workspace member with form-read permission.
getFormForSubmission
Get a single form by id for submitting it, including its jsonFormData questions. Access: submission-scoped (the rules for opening the form to submit it); unlike getForm, form-read permission is not required.
getReverseGeocode
Reverse geocode coordinates to an address via Geoapify (server-side proxy). When no address is found, formatted falls back to "lat, lon".
Access: Requires a logged-in user, or formId with access to that form (public submitters).
Errors: Throws if coordinates are invalid, geocoding is not configured, the geocoding service is unreachable, or the rate limit is exceeded. Returns null when unauthorized.
getGeocodedAddresses
Coordinates for a batch of street addresses, in the order sent. Each distinct address is geocoded once, ever: the result (including "no match") is stored and every later call, from any app or user, reads it without contacting the geocoder. Use this to put records that hold an address as plain text on a map.
Access: Requires membership of the workspace.
Errors: Throws if more than 100 addresses are sent, geocoding is not configured, or the per-user rate limit is exceeded. Addresses beyond this call's lookup budget, or that the geocoder failed on, come back with pending true and are not stored; call again for them.
getGoal
Fetches a single goal by ID with its full details. Returns null when the goal does not exist or the caller is not a member of its workspace. When workspaceId is supplied, goals outside that workspace also return null.
Access: workspace members (external users excluded).
getGoals
Retrieve goals from a workspace with optional filtering and pagination
If asked to get a specific user's goals, ensure to filter by ownerIds.
goalsEasySearch
Quick search for goals by name, for finding a goal ID from a partial name. Ranks by text match and recency, returns up to limit results, and only goals shared with the caller. assignees narrows to goals owned by those users or teams.
Access: workspace members (external users excluded); returns empty otherwise.
crossWorkspaceGoalsVisualization
Read-only cross-workspace goals visualization.
Accepts a list of workspace IDs and returns a flat list of goals across the workspaces the viewer can access. Inaccessible workspaces are omitted silently (no error is surfaced) so that the caller cannot probe membership via this API.
Caps:
- up to 5 workspaces per request
- up to 200 goals total across workspaces
Access model reuses the existing per-workspace goal access primitives (workspaceIdAccessCheck + getGoalAccessClause); external workspace members are excluded, matching the single-workspace goal widgets.
scheduledGoalMetricSyncs
Cron jobs that periodically re-sync a goal's currentValue from its source widget. Empty when the goal has no schedule (unscheduled goals with a sourceWidgetId are synced by the workspace-wide daily sweep instead).
getOrCreateGoalMetricSourcesDashboard
Returns the caller's hidden "Goal metric sources" dashboard for the workspace, creating it on first use. Pivot widgets that back automated goals live on it; pass its _id as containerId when creating a goal's source widget. Upserts a Dashboard document, so it is a write despite being a query.
getTables
Table definitions the caller can see, optionally filtered to one accessible project. Access: Tables workspace permission and per-table read access; project access when filtered. Errors: Authentication, workspace access, Tables permission, or project access errors.
getRecords
Lists records in one Hive table with filtering, sorting, and pagination. Returns only tables and rows the caller can access.
aggregateRecords
Calculates filtered totals for records the caller can access in one Hive table.
getDistinctRecordValues
Lists the distinct non-empty values of one text field across the records the caller can access, most common first. filter and search narrow the records counted; limit defaults to 100 and is capped at 500.
searchLinkedEntities
Searches Hive entities by name or resolves display labels for known entity IDs. Results are limited to the supplied workspace and the caller's access; unsupported entity kinds return an error.
getTableViews
Saved views for one table the caller can see: own views, views shared with them, and workspace-wide views. Requires table read access.
recordsEasySearch
Primary-field text search across accessible tables/records
groups
Lists Hive direct messages, group chats, and threads the caller can access. Supports member, type, text, sorting, and cursor-pagination filters. Use member IDs to resolve a chat ID before sending a message; use type instead of deprecated oneToOne. Requires workspace and chat access.
getActionHighwayUsageSummary
Returns all recorded Highway run usage totals and coverage after checking access to the action.
getActionHighwayRuns
Lists durable run history after checking access to the owning action.
getActionHighwayRun
Returns safe details of a run belonging to this action.
getActionHighwayUsage
Returns a bounded page of measured invocation usage for an owned run.
getActionHighwayProgress
Returns a bounded page of sanitized structured progress for an owned run.
getAdminHighwayUsage
Returns persisted invocation usage in Highway Admin.
adminHighwayRuns
Lists Highway runs. Prompt text is available only through adminHighwayRun.
adminHighwayRun
Returns one Highway run, including its initial prompt when available.
adminHighwayRunEvents
Returns one bounded page of Highway worker events. Keep first, types, and search unchanged while following nextToken. first is optional for the existing admin UI but required by MCP. With tail, the newest page comes back first and backwardToken walks one page older per request; without it events are read oldest first.
adminHighwayRunCommands
Lists command state for a Highway run. Command prompt text is intentionally excluded.
adminHighwayRepoCommands
Lists supported Highway slash commands for a repository ref.
adminHighwayRepoBranches
Searches repository branches available to Highway.
adminHighwayCiOverview
Returns bounded Highway CI health, failure trends, and flaky-test data. Access: Highway admin on secure VPN. Errors: unauthorized callers or unavailable data.
accountManagementStatus
Flywheel's state for one account, for the settings card. Access: any user with CRM access to the account.
getActionableAccountCallMails
The signed-in user's Flywheel call-mails, soonest first. Access: Workspace members with CRM access. Errors: The caller is unauthenticated or lacks CRM access.
accountFlywheelFleet
One page of Flywheel's fleet: every Hive HQ account with a run row, joined to its owner, its open opportunity, the work it has going and its newest journal entry, sorted by next check. ATC boards Hive HQ only, so there is no workspace to name. Access: Hive HQ operator — super admin with Hive HQ membership.
accountFlywheelJournal
One Hive HQ account's decision timeline, newest first: what each decision saw, what it started and how each row ended, plus the runs that stopped and the dials an operator turned. An account outside Hive HQ reads as not found. Access: Hive HQ operator — super admin with Hive HQ membership. The journal is the executor's record; reading every account's is deliberately an operator's view of the fleet, not theirs.
accountJournalFeed
Every journal line across all of Hive HQ's accounts, newest first: decisions, the work they
started, stopped runs and operators' dials. Filter by kind, by the owner Flywheel ran as, by
account, or by a case-insensitive match on the account's name. Pages are cursor-paged and capped.
The same rows arrive live through the accountJournal app subscription.
Access: Hive HQ operator — super admin with Hive HQ membership.
accountActivityFeed
Alias of accountJournalFeed with the same arguments and rows. Not @deprecated yet: the tool catalog skips deprecated operations, and shipped ATC versions call this tool by name. TODO(flywheel-activity-alias-removal): remove after the deprecation window, in a follow-up PR.
accountFlywheelAttention
Everything in Hive HQ that may need a person, each row carrying why. A row appearing here twice for the same reason is a defect in the loop, not a queue to work. Access: Hive HQ operator — super admin with Hive HQ membership.
accountFlywheelCutoverStatus
One row per behaviour: Hive HQ's existing workspace setting, whether Flywheel owns it in this build, and how much work of that capability ran, beside Hive HQ's own count of switched-on accounts and how the window's runs ended. This is the board that shows a cutover actually landed. Access: Hive HQ operator — super admin with Hive HQ membership.
accountFlywheelApprovals
Every tool approval Flywheel's work is parked on at Hive HQ, whoever its executor is — a real
person or an Auto user (flywheelAuto) — newest first. Each row carries its owner, account
and creation time, so a caller filters by owner, account or age, and counts the queue and
its oldest entry from the rows. Only yes-or-no approvals on a Flywheel work row the executor
owns are listed; questions and campaign approvals keep their own rails.
Access: Hive HQ operator — super admin with Hive HQ membership.
accountFlywheelCallMails
Every call-mail Flywheel prepared at Hive HQ that is still a call to make, whoever's it is, soonest due first, each with the owner whose call it is. Read-only: logging the call and sending the prepared email are the owner's, who made the call. Access: Hive HQ operator — super admin with Hive HQ membership.
accountFlywheelMeetings
Hive HQ's customer calls around now: the ones being recorded and shared live, the ones starting in the next two hours, and the ones that ended in the last two. A live call is one whose recorder's heartbeat is fresh and who chose to share it live; a call recorded privately never appears. Upcoming and recent calls are the ones that resolve to one customer account. Access: Hive HQ operator — super admin with Hive HQ membership.
accountFlywheelMeetingTranscript
The live transcript segments of one call after an index, oldest first and capped, for polling.
Answers only while the call is live and shared; otherwise live is false and no segments
are returned. A row outside Hive HQ reads the same way.
Access: Hive HQ operator — super admin with Hive HQ membership.
getCustomerPreparationSourcePage
Internal worker: lists an account's preparation sources, either the 1-20 sourceIds given or a paged inventory of its history (use after for the next page; metadataOnly skips content). Access: trusted HiveMind service with access to the account. Errors: sourceIds outside 1-20, invalid cursor, or history over the preparation source capacity.
getCustomerPreparationSourceContents
Reads bounded account evidence with a resumable offset for long records. Access: trusted HiveMind service with current CRM and contributing-source access. Errors: unavailable source, invalid offset or changed source during pagination.
getCrmAccountMemory
Read account background and current plan. Access: account CRM access and access to every contributing source.
getAccount
Fetches a single CRM account by ID with its full details. Returns null when the account is deleted; use getAccounts to search or list accounts.
Access: workspace members with CRM access. Errors: account not found.
getSidekickCustomerCallFacts
Returns current product and billing facts for the account explicitly linked to a meeting. Access: Hive HQ members with CRM read access only. Errors: standard authentication, workspace, and CRM access errors.
getAccountSubscriptionAggregate
Aggregates CRM account subscription values such as total account ARR, subscription ARR, addon ARR, addon quantity, or subscription seats. Read-only; callers can use the result to update a goal through updateGoal.
accountProductActivity
Cognition-gated product activity rollup from customerEventLog for this CRM account. lookbackDays is clamped to 90.
getAccountMaterials
Files and File Library folders linked to this CRM Account as materials. Gated by account access.
getCrmAssociations
Lists CRM associations matching the supplied entity filters.
getProjectAccountLinks
Lists CRM accounts linked directly to a project. Access: requires access to the project and matching workspace. Errors: standard authentication and project access errors.
getAccountProofingGuidelineNodes
Lists proofing guideline file/folder nodes linked to an account. Access: requires access to the account.
getProjectProofingGuidelineDocuments
Lists proofing guideline files from accounts linked to a project or accessible ancestors. Access: requires access to the project and matching workspace. Errors: standard authentication and project access errors.
getCrmAuditLogs
Field-level change history for one CRM record, newest first.
Access: Workspace members with CRM access.
getCrmWorkspaceMemory
Reads the workspace's CRM memory: its standing CRM rules.
getCampaignAudiencePipeline
Read existing pipeline state and a bounded recipient preview. Access: campaign CRM readers.
previewCampaignPeopleList
Resolves up to 1000 pasted names or email addresses for review without writing recipients. Access: caller must have CRM access to the campaign workspace. Errors: unauthorized access, empty or oversized lists, and invalid identity selections are rejected.
getCampaignEngagementTimeline
Campaign email activity by calendar day in an IANA time zone (UTC when unknown): emails sent, and people who first opened or first clicked a link. Days without activity are omitted. Access: caller must have CRM access to the campaign workspace.
getCampaignEngagementPeople
The people behind one campaign Stats number: who was emailed, opened, clicked a link or replied, with when and how. Only recipients still on the campaign are listed. Access: caller must have CRM access to the campaign workspace.
getCampaignBookedMeetings
Meetings booked after a campaign recipient's first email, using the Stats booking rules. A meeting is listed once even when several recipients attended. The Stats total counts people. Access: CRM access to the campaign workspace and read access to each returned meeting. Errors: Throws when the campaign is missing or the caller lacks CRM access.
getCampaignToolApprovals
Lists campaign-native Buzz approvals assigned to the current execution actor.
scoreCampaignAudience
Read-only LLM scoring of candidate persons against a persona. No campaign state is mutated; results are not persisted.
discoverCampaignAudienceData
Discovers CRM audience source data for campaign audience design. Access: caller must be a non-external member of the workspace. Errors: invalid or unauthorized workspace access is rejected.
previewCampaignAudience
Previews candidate audience rows for a proposed campaign audience definition. Deprecated: use previewCampaignAudienceResult for empty-state metadata. Access: caller must be a non-external member of the workspace. Errors: invalid or unauthorized workspace access is rejected.
previewCampaignAudienceResult
Previews candidate audience rows and empty-state metadata for a proposed definition. Access: caller must be a non-external member of the workspace. Errors: invalid or unauthorized workspace access is rejected.
getCampaignAccountMeetingSignals
Future linked-meeting signals for campaign accounts. Used in the builder people step to filter accounts eligible for add-to-meeting plays. Counts only meetings you can read. A meeting is readable when you are its organizer or an attendee, when it is linked to a CRM record and you have CRM access, or when you hold a meetingUserData doc for it (your own, or one shared with you by name); 'everyone' sharing grants nothing.
getCampaignPersonSpamRisks
Spam risk per person for campaign audience selection. Read-only; nothing is persisted. Up to 1000 people per call; every requested person gets a row. Access: caller must have CRM access to the workspace. Errors: unknown campaignId or unauthorized workspace access is rejected.
getCampaignTable
The campaign's audience table, or null when it has not been created yet. Access: caller must have CRM access to the campaign workspace.
getCampaignCrmColumnOptions
CRM person and account fields that could be columns of the campaign table, with how many rows have a value for each. Access: caller must have CRM access to the campaign workspace.
getCampaignPilot
Read the pilot recipient, saved research, first draft, and campaign preparation progress. Requires CRM access.
getCampaignCellResearch
Details behind one campaign table cell: for a criteria column the metrics breakdown, the research score and the Campaign Score; for a research column the result. With sources. Null when the cell has no details. Access: caller must have CRM access to the campaign workspace.
getCampaignCellResearchStates
Research docs of a campaign in the given statuses (default queued, running, failed), for cell spinners and failure badges. Results whose cell write has not landed yet come back whatever statuses are asked for, so a cell keeps its spinner until it shows the new value. Light: read details with getCampaignCellResearch. Access: caller must have CRM access to the campaign workspace.
getCampaignResearchProgress
Counts of research on the campaign that has not settled yet, for the progress band. Access: caller must have CRM access to the campaign workspace.
draftCampaignAudienceDefinition
Designs an audience definition for new criteria from a description without saving anything. Used by the hidden Buzz thread designing a criteria; preview it with previewCampaignAudience. Access: caller must have CRM access to the campaign workspace.
getCampaignPlays
Lists the full catalog of CRM plays (the strategic reasons for pursuing a recipient) with their scopes, default contact approach, and preferred artifacts. Use it to pick a play slug for recipient strategies or associations.
Access: any logged-in user; the catalog is the same for every workspace.
getCampaignPlay
Fetches one CRM play from the catalog by slug. Returns null for an unknown slug.
Access: any logged-in user.
getCampaignRecipients
Lists recipients for a CRM campaign, or only the given people's recipients with personIds. With launchableByViewer, only unlaunched emails the viewer may launch: their own and those of senders who named them a send delegate.
getCampaignRecipientPersonSelections
Lists which people are already recipients of a campaign, one entry per person with their recipient ID and status. Lighter than getCampaignRecipients when only membership is needed.
Access: workspace members with CRM access. Errors: campaign not found.
getAccountCampaignRecipientStates
Lists unsuppressed planned, active, waiting and approval-pending work for an account in active or paused campaigns. Access: current CRM access in the account's workspace. Returns at most 200 records; a full page may omit further commitments.
getCampaignSendCalendar
Real email totals grouped by Eastern day, sender, batch, step and preparation stage. End day is exclusive; the range is limited to 42 days. Access: users with CRM access to the campaign workspace. Errors: missing campaign, denied workspace access or invalid date range.
getCampaignFollowUpRecipients
Everyone who got the campaign's original email, with where the follow-up step stands for each: scheduled with its send time, sent, replied, skipped with the reason, or failed. Access: caller must have CRM access to the campaign workspace. Errors: missing campaign or follow-up step.
getPersonStats
Counts CRM people matching the provided workspace filters. Access: caller must be a non-external member of the workspace. Errors: invalid or unauthorized workspace access is rejected.
getStoredEmailForMailThread
Resolve a CRM stored email row for the current Hive Mail thread context. Returns null when the thread has not been imported into CRM yet.
getStoredEmailAttachmentContent
Fetch a stored CRM email attachment's content from the mailbox owner's connected provider account. Requires CRM access to the email and resolves the owner (the user whose synced mailbox produced it), so any authorized teammate can download — not only the original recipient. Reuses EmailAttachmentContent.
getCrmEmailImportCoverage
Rollup of what email import did with the threads it was handed, over a trailing window. Answers how much mail a workspace is not capturing and why — the skip reasons are decided per thread at import time and were otherwise discarded.
Counts only. Nothing identifying the threads or their participants is recorded, deliberately: threads with no CRM relationship are dropped without storing anything about them, and a per-thread skip log would put exactly those addresses back into the database.
getForecastSnapshots
Lists point-in-time forecast snapshots (amount, probability, forecast category, confidence) for CRM opportunities, newest first. Filter by opportunityId to see how one deal's forecast changed, or by period.
Access: workspace members with CRM access.
getForecastSummary
Totals the forecast from each opportunity's latest snapshot: totalAmount, commitAmount (commit category only), and snapshotCount, optionally for one period. Per-currency subtotals use captured currencies. unknownCurrencyCount counts snapshots excluded from those subtotals.
Access: workspace members with CRM access.
getCrmLinkedMeetings
Lists one row per workspace meeting the caller can read that holds content, newest first or most recently changed first. A meeting is readable when you are its organizer or an attendee, when it is linked to a CRM account or opportunity and you have CRM access, or when it is shared with you by name; 'everyone' sharing grants nothing. Since this requires CRM access, every CRM-linked meeting with content is listed; a meeting nobody has written on has no row here. Set includeScheduled to include upcoming meetings and calendar-only meetings without saved content. bookingDateFrom/bookingDateTo filter the provider's original creation time, independently of the appointment's start time. Missing provider timestamps are excluded from a booking-date filter. CRM links (people, accounts, opportunities) decorate and filter the rows. Access: Workspace members with CRM access. Errors: Throws if the user is logged out or lacks CRM access.
getMeetingFollowUpDraftSettings
Returns post-call follow-up draft settings. Access: workspace admins with Hive CRM enabled.
getMeetingFollowUpDraftWorkflow
Compatibility API for clients that still render the retired workflow editor.
getMeetingFollowUpDraftReadiness
Returns Zoom, mailbox, and observed transcript readiness for post-call follow-up drafts. Access: workspace admins with Hive CRM enabled.
getCrmTableSavedViews
Returns the current user's saved CRM table views and the views shared with everyone in the workspace. Access: Workspace members with CRM access.
getResourcingSavedViews
Saved views for one resourcing surface: the caller's own views plus every view shared with the workspace, oldest first. Access: workspace members.
getCrmForms
Lists CRM forms for a workspace. Access: workspace members with CRM access. Errors: invalid or unauthorized workspace access is rejected.
getFinanceWipAccountOptions
Lists the active workspace accounts each WIP settings slot accepts, without ledger balances. Access: Requires the finance feature and setup update permission, matching updateWipSettings. Errors: Throws when the user is not logged in, finance is disabled, or setup update is denied.
getFinanceWholeWorkspaceStatementReadable
Whether this reader may ask for the unnamed, whole-workspace statement — the trial balance, balance sheet, GL detail and profit and loss measured over every set of books at once. True where no company restricts anybody, or where the reader holds every company the workspace has; false where their finance access covers only some of them, which is exactly when those four queries require a glCompanyId. A statement surface asks this before it offers a scope, because nothing else it holds can answer: the refusal only arrives after a statement has already failed, and getFinanceGlCompanies and getFinanceGlCompaniesCount are both narrowed to the reader's own companies, so neither reports the total the rule compares against. One boolean is deliberately the whole answer — how many companies a reader cannot open, or which, is what the assignment exists to withhold. Access: the same gate as the statements it describes — reportsRead in a workspace where finance is enabled. Errors: the workspace is not found, finance is disabled for it, the caller is not a member, or they lack reportsRead.
getFinanceAdvanceBillingAccountOptions
Lists the GL accounts an advance bill may be issued against, without balances. Access: Requires the finance feature and the billing invoice generate permission — the same permission createAdvanceBilling enforces, so anyone shown this picker can issue what it offers. Errors: Throws when the user is not logged in, the workspace has finance disabled, or the user lacks the billing invoice generate permission.
getFinanceClientAccountOptions
Searches the counterparties a finance document may name — the client it is billed to or the vendor it is owed to — a page at a time, by name. search narrows on any part of the name; omitting it returns the first page alphabetically. selectedId names a counterparty already chosen, which comes back whether or not the search finds it, so a picker can always render its own value by name rather than by id. Access: Requires the finance feature and any one of the billing invoice generate, purchasing create, billing worksheet create or setup update permissions — each authors a document that names a counterparty. Deliberately not the CRM read: a bookkeeper who bills need not hold a CRM grant, and a workspace can run finance without the CRM feature at all. Errors: Throws when the user is not logged in, the workspace has finance disabled, or the user holds none of those permissions.
getAccountingPeriodUnownedPostings
The posted journals no period on the register owns — the complement of every period-scoped read, and the only place the question can be asked: a period sheet reports what it owns, and nothing owns these.
glCompanyId narrows to one company's books on the same terms as getAccountingPeriods.
getCashFlowJournals
One page of posted journals contributing cash to a statement activity total. Access: Members who can read the requested Finance report and company books. Errors: Requires Finance report access, a readable company when selected, and a bounded posting-date range.
getCreditMemoRevenueAllocation
Returns the revenue allocation breakdown for a credit memo.
getAccountingMappingTaxAgencies
Imported tax agencies for accounting mappings, including retired identities used by history. Requires finance access.
getSetupProfile
Returns the workspace finance setup profile. Writes: creates the workspace's finance setup profile on first use.
getFinanceOrgShape
The org-shape facts the finance surface filters itself by: which optional-by-org sections this workspace has at all.
Access: Requires the finance feature, and nothing more — a user who may open Finance may learn which of its surfaces exist here, the same way the nav itself is not a permission.
Errors: Throws when the user is not logged in or the workspace has finance disabled.
getFinanceCashAccountOptions
Live cash accounts available to members who can record customer payments, without balances.
getFinanceControlAccountOptions
Lists the accounts finance setup offers for one control-account slot, without their balances.
The eligibility rule is the slot's, so kind decides what comes back: the four liability kinds return the workspace's active other current liabilities, while accountsReceivableAccountId and revenueAccountId return accounts of their own type. Omitting it keeps the original answer — the other current liabilities — for callers that predate the per-slot pickers.
Access: Requires the finance feature and the setup update permission — the same permission updateSetupDefaults enforces, so anyone shown this picker can save what it offers.
Errors: Throws when the user is not logged in, the workspace has finance disabled, or the user lacks the setup update permission.
getFinanceMulticurrencyAccountOptions
The accounts a multicurrency gain/loss or rounding account may be chosen from — active income-classified accounts in this workspace. Authorizes as getFinanceControlAccountOptions does: the finance feature plus the setup update permission, so anyone shown the picker can save what it offers.
getFinancePermissionContext
Returns the current user’s finance role and action permissions for the workspace.
getSetupReadiness
Returns finance setup completion and outstanding requirements. Writes: creates the setup profile on first use and stores the section statuses it computes.
getFinanceServicesLaunchReadiness
Returns readiness details for launching finance services. Writes: creates the setup profile on first use and stores the section statuses it computes.
getSetupAuditEvents
Lists finance setup changes matching the supplied source filters.
getDocumentNumberSequences
Lists document-number sequences matching the supplied filters.
getDocumentNumberSequencesCount
Counts document-number sequences matching the supplied filters.
getAccountingMappings
Lists accounting mappings matching the supplied filters.
previewAccountingMapping
Validates an accounting mapping input and returns any mapping issues.
getFinanceEmployeeProfiles
Lists finance employee profiles for the workspace.
getFinanceEmployeesProfilesSetup
Lists employee finance profiles and setup status matching the supplied filters.
getFinanceEmployeesProfilesSetupCount
Counts employee finance profiles matching the supplied search.
getFinanceEmployeesUsers
Lists workspace users available for finance employee setup.
getFinanceEmployeesUsersCount
Counts workspace users matching the supplied finance employee search.
getProjectTemplates
Lists project templates matching the supplied status and search filters.
getProjectTemplatesCount
Counts project templates matching the supplied status and search filters.
getProjectsFinancials
Returns finance details for the selected projects.
getProjectBudgetVersions
Lists budget versions for a project matching the supplied filters.
getProjectBudgetVersionsCount
Counts budget versions for a project matching the supplied filters.
getExpenseReports
Lists expense reports matching the supplied status and search filters.
getExpenseReportsCount
Counts expense reports matching the supplied status and search filters.
getPurchaseOrders
Lists purchase orders matching the supplied status and search filters.
getPurchaseOrdersCount
Counts purchase orders matching the supplied status and search filters.
getWorksheetSources
The billable transactions still available to put on a worksheet.
startDate and endDate bound the selection to a billing period, matched against each source's own business date and inclusive of the whole end day. Either bound may stand alone. Purchase-order lines carry no business date and are offered whatever period is named.
getWorksheets
Lists billing worksheets matching the supplied project, status, and billing filters.
getWorksheetsCount
Counts billing worksheets matching the supplied project, status, and billing filters.
getFinanceCustomerInvoices
Read customer invoices and their existing payment applications, with bounded pagination. Access: finance enabled and visibility of the invoice company. Errors: workspace access denied or an unknown accounting period.
getFinanceCustomerInvoicesCount
Count the invoices selected by the same company, period and currency filters as the list. Access: finance enabled and visibility of the invoice company. Errors: workspace access denied or an unknown accounting period.
getCustomerInvoiceLines
Read lines from one customer invoice, including source identities and billing descriptions. Access: finance enabled and visibility of the parent invoice company. Errors: invoice not found or access denied.
previewCustomerInvoiceLineTax
Calculates tax for a proposed customer invoice line without saving it.
getCustomerInvoiceLayouts
Lists customer invoice layouts matching the supplied filters.
getCustomerInvoiceLayoutsCount
Counts customer invoice layouts matching the supplied filters.
getVendorPayments
Vendor payments recorded in the workspace, newest first. Narrow to one purchase order or one of its bills to read what has been paid against it, or to one payee to read that payee's register. Access: finance enabled in the workspace.
getVendorPaymentRuns
AP payment runs recorded in the workspace, newest first. Narrow by vendorPaymentRunId to read one run with its groups, allocations and per-group outcomes — the review surface a draft run exists to be. Access: finance enabled in the workspace, matching the sibling getVendorPayments read.
getFinanceCreditMemos
Lists finance credit memos matching the supplied filters.
getFinanceCreditMemosCount
Counts finance credit memos matching the supplied filters.
getMassBillingQueue
Returns billing items ready for mass invoicing.
getBillingStatusReport
Summarizes billing status using the supplied report filters.
getBillingStatusReportPage
Billing status as a page: a capped drill-down beside the count of the population it was cut from. Read this rather than getBillingStatusReport on any surface that renders the rows — the uncapped field hands a large workspace every worksheet line and customer invoice it has. Access: workspace members with finance read access. Errors: throws when the caller is anonymous or has no finance access to the workspace.
getProjectProfitability
Returns profitability details for a project.
getProjectProfitabilityReport
Summarizes project profitability using the supplied report filters.
getProjectProfitabilitySummary
The Project profit tile on the reports landing, without the report's rows. Read this rather than getProjectProfitabilityReport on any surface that draws the figure and the count and renders no rows — it is the same reduce over the same rows, made on the server. Access: workspace members with finance read access. Errors: throws when the caller is anonymous or has no finance access to the workspace.
getClientProfitability
Summarizes profitability by client using the supplied report filters.
getServiceProfitability
Summarizes profitability by service using the supplied report filters.
getServiceAndItemProfitability
Returns profitability rows for native services and canonical Service-type items, with explicit identity for the source each row represents. Access: workspace members with finance read access. Errors: throws when the caller is anonymous or lacks finance access to the workspace.
getUtilizationReport
Returns staff utilization results for the supplied report filters.
getOverServicingReport
Identifies projects whose delivered work exceeds their planned service amounts.
getBillingPipelineReport
Summarizes work and invoices moving through the billing pipeline.
getBillingPipelineSummary
The Billing pipeline tile on the reports landing, without the report's rows. Read this rather than getBillingPipelineReport on any surface that draws the figure and the count and renders no rows — it is the same reduce over the same rows, made on the server. Access: workspace members with finance read access. Errors: throws when the caller is anonymous or has no finance access to the workspace.
getArStatusReport
Summarizes accounts-receivable balances by status.
getArStatusReportPage
AR status (collections) as a page: full-population bucket totals beside a capped drill-down. Read this rather than getArStatusReport on any surface that states a balance — the totals come from buckets, so the row cap cannot move the money on screen. Access: workspace members with finance read access. Errors: throws when the caller is anonymous or has no finance access to the workspace.
getArAgingReport
Summarizes accounts-receivable balances by age as of the selected date.
getApAgingReport
Summarizes accounts-payable balances by age as of the selected date.
getFinanceControlBalanceSeries
A control account's balance over time — receivables, payables, or cash per the general ledger. Reconstructed from posted journal movement rather than read from a stored history, so a point is only as exact as the lines behind it: check each point's unconvertedRowCount before drawing it. Access: workspace members with finance reports read access. Errors: throws when the caller is anonymous, has no finance report access to the workspace, or names a range that ends before it starts or holds more than 400 periods.
getFinanceDashboardSummary
Returns summary metrics for the finance dashboard. Writes: creates the workspace's finance setup profile on first use.
getFinanceReportSavedViews
Lists saved finance report views for the selected report.
getAccountingReferences
Lists accounting references associated with a finance source record.
getFinanceExchangeRates
Stored exchange rates for the workspace, newest first. Access: members of the workspace, in a workspace where finance is enabled. Errors: the workspace is not found, finance is disabled for it, or the caller is not a member.
getFinanceExchangeRatesCount
How many rates the same filter returns, for the list's total. Access: same gate as getFinanceExchangeRates.
getFinanceExchangeRateCoverage
The currency pairs this workspace's books require and whether each one has a stored rate, so the register can say which conversions it cannot perform rather than only which rates it holds. Access: same gate as getFinanceExchangeRates. Errors: the workspace has no finance setup profile, so it has no base currency to require pairs against.
getFinancePaymentTerms
Payment terms for the setup section and for the invoice pickers.
Access: finance feature access on the workspace, like every other setup read.
pickableOnly is what separates the two callers. A picker may only offer a term an invoice can actually be billed on, so it drops the terms whose stored rule derives no due date — the same ones the section renders as 'Due rule not provided'. The section itself leaves it off: it shows what the workspace has, fallback label and all, because that is the row someone has to fix.
getFinancePaymentTermsCount
Counts finance payment terms matching the supplied filters.
getFinanceAttachments
Lists attachments linked to a finance source record.
getAccountingDiagnostics
Returns accounting diagnostics for the workspace.
getAccountingIntegrationHealth
Returns the connection and sync health of accounting integrations.
getGLAccounts
Lists the workspace chart of accounts, optionally with posted balances through a UTC calendar day. Access: accounting read permission in the workspace.
getGLAccount
Reads one workspace account, optionally with its posted balance through a UTC calendar day. Access: accounting read permission in the workspace. Errors: account not found.
getGLAccountRecentLines
Lists recent journal lines for a general-ledger account.
getWipSettings
Returns work-in-progress posting settings for the workspace or project.
getWipBatches
Lists work-in-progress posting batches matching the supplied filters.
getWipBatchesCount
Counts work-in-progress posting batches matching the supplied filters.
getAdvanceBillings
Lists advance billings matching the supplied client and status filters.
getAdvanceBillingsCount
Counts advance billings matching the supplied client and status filters.
getAccountingPeriods
Lists accounting periods matching the supplied filters.
getJournals
glCompanyId narrows the list to one company's books, on the same terms as getAccountingPeriods: it resolves through the company scope rule, so naming the default company also lists the journals written before any company existed. Omitted, the list stays narrowed to the reader's own assigned companies.
getJournal
Read one journal. An optional period restricts the company, including journals posted outside that period. Access: accounting read permission and visibility of the selected company. Errors: journal unavailable or period inaccessible.
getJournalsCount
Counts journals matching the supplied company, period, status, and search filters.
getJournalsCensus
The register's own figures over the scope it is showing — the same narrowing getJournals and getJournalsCount take, so the header and the rows cannot describe different populations.
getJournalBalance
Returns the current debit and credit totals for a general-ledger journal.
getGLDetailReport
GL activity lines. When startDate and endDate are both omitted, results are capped to the most recent 300 posted journals for performance. glCompanyId names the books these lines belong to; it carries the statement rule of the trial balance they add up to, so a company the reader may not open is refused by name and the unnamed whole-workspace stream is served only to a reader who holds every company.
getGLDetailReportCount
Counts general-ledger detail rows matching the supplied report filters.
getTransactionReport
Every transaction behind one profit-and-loss cell — QuickBooks' Transaction Report, reached by clicking a number on the statement.
Every argument but the account is one the profit and loss was already reading: the same basis, the same dimension, entity and company filters, and — critically — the clicked column's own start and end rather than any date range the report surface offers. Handed the parameters that defined a cell, this runs the same derivation the statement ran for it, which is why the report's grand total equals the number clicked with no filter for the reader to adjust.
The account's children come with it, because a profit-and-loss row rolls its children up.
Refuses rather than answering untied: a cell whose transactions do not fold back to the statement's own figure returns TRANSACTION_REPORT_UNTIED, and one covering more transactions than the report will render returns TRANSACTION_REPORT_TOO_BROAD instead of a truncated list under a whole-population total.
getTrialBalanceReport
Reads account debit, credit, and net balances as of a date, including whether the books balance. Access: Requires Finance reports read permission and access to the requested companies. Errors: Throws when the caller cannot read the report or requested company.
getCashFlowStatementReport
Returns a cash-flow statement for the selected date range and columns.
getBalanceSheetReport
Returns a balance sheet as of the selected date, with optional comparisons.
getCloseReadiness
Returns period close readiness and outstanding reconciliation requirements.
getTrainingDataCleanupPreview
Previews finance training data that can be removed from the workspace.
getFinanceWorkspaceResetPreview
Previews the finance data affected by a workspace reset.
getFinanceReportDisplaySettings
The resolved report display settings for this workspace and reader. Read before a report is requested, so a surface can open on the basis the client's own QuickBooks company reports on rather than on a default of its own. Gated on reportsRead, like every other report query.
getProfitLossReport
Profit and loss statement over a required period, with optional columns and comparison buckets. When comparison dates are omitted, the server derives them from compareTo. glCompanyId names the books the statement covers, on the same terms as the trial balance: a company the reader may not open is refused by name, and the unnamed whole-workspace statement is admitted only to a reader who holds every company. Cash basis takes a company on the same terms: its recognized figures are the settled document's own posted lines, and the unapplied cash that has no line is kept with the receipt or vendor payment whose books took it in.
getFinanceProfitLossReadiness
Pre-flight checks for P&L reporting: chart-of-accounts coverage, posted journals, and unposted source documents.
getFinanceUnpostedDocumentCount
How many imported documents the ledger has not taken in — the one figure a statement's caveat states. The cheap half of getFinanceProfitLossReadiness, for the surfaces that print a statement's totals rather than the readiness verdict: no chart-of-accounts classification, no journal coverage, no orphan-line sweep, and no date, because none of the document populations it counts is bounded by the statement's window. Gated on reportsRead, like every other report query.
getInitialClosingDate
Returns the initial closing date configured for the workspace.
getFinanceMigrationPreflight
Checks workspace readiness before starting a finance data migration.
getFinanceMigrationRunSummary
Returns a summary of one finance migration run.
getFinanceMigrationRuns
Lists finance migration runs for the workspace.
getFinanceMigrationRows
Lists rows in a finance migration run matching the supplied filters.
getFinanceMigrationValidationSummary
Returns validation totals and issues for a finance migration run.
getFinanceMigrationSupportedSources
Lists accounting providers supported for finance migration.
getFinanceQuickBooksMigrationDiscovery
Returns QuickBooks data available for migration to Finance.
getFinanceXeroMigrationDiscovery
Returns Xero data available for migration to Finance.
getFinanceXeroProjects
Lists paginated project and billing-summary data from the workspace Xero organisation. Access: Requires Finance access, accounting read permission, an enabled workspace Xero sync, and a sync owner connection with the projects.read scope. Errors: Throws when the user is not logged in, Finance or accounting access is denied, Xero sync is unavailable, the connection needs the projects.read scope, or Xero rejects the request.
getReconciliations
Lists bank reconciliations matching the supplied account and period filters.
getReconciliationLines
Lists the bank and book lines in a reconciliation.
getReconciliationSummary
Returns totals and status for a bank reconciliation.
getPostingBatches
Lists finance posting batches matching the supplied filters.
getPostingBatchDetail
Returns the details and results of a finance posting batch.
getPostingBatchesCensus
Counts posting batches by status over the same period, search and status filters as the posting-batch register.
Access: Requires the finance feature and accounting read permission.
Errors: Throws when the user is not logged in, Finance or accounting access is denied, or the requested period does not exist in the workspace.
getOpenPayables
Lists payable documents with outstanding, original, and paid amounts and due dates. Use limit and skip to page through results; getOpenPayablesCount returns the matching total. Access: Requires Finance access and restricts results to the caller's companies. Errors: Throws when the caller cannot access Finance in the workspace.
getOpenPayablesCount
Counts payable documents matching the same filters and company access as getOpenPayables. Access: Requires Finance access in the workspace. Errors: Throws when the caller cannot access Finance in the workspace.
getItems
Lists finance items matching the supplied type, status, and search filters.
getItemsCount
Counts finance items matching the supplied type, status, and search filters.
getTaxCodeCatalogEntries
Lists available tax-code catalog entries for the selected provider.
getDimensions
Lists finance reporting dimensions matching the supplied filters.
getDimensionsCount
Counts finance reporting dimensions matching the supplied filters.
getFinanceGlCompanies
GL companies for the workspace. Unsorted — and when sorted by the Role column, which is how the list opens — the default company comes first and the rest follow by code; any other sortBy replaces that ordering. A workspace that has provisioned none returns empty, so callers must handle that rather than assume a head. Access: members of the workspace, in a workspace where finance is enabled. Errors: the workspace is not found, finance is disabled for it, or the caller is not a member.
getFinanceGlCompaniesCount
How many GL companies the same filters return, for the list's total. Access: same gate as getFinanceGlCompanies — members of the workspace, in a workspace where finance is enabled. Errors: the workspace is not found, finance is disabled for it, or the caller is not a member.
getFinanceIntercompanyMappings
The company pairs that may post to each other, and the accounts they post through. Ordered by the pair unless another column is sorted. A search term is matched against the companies and accounts a mapping references, not against its stored ids. Access: members of the workspace, in a workspace where finance is enabled. Errors: the workspace is not found, finance is disabled for it, or the caller is not a member.
getFinanceIntercompanyMappingsCount
How many intercompany mappings the same filters return, for the list's total. Access: same gate as getFinanceIntercompanyMappings. Errors: the workspace is not found, finance is disabled for it, or the caller is not a member.
getFinanceIntercompanyAccountOptions
Lists the accounts each leg of an intercompany mapping may be chosen from, without balances. Access: Requires the finance feature and the setup update permission — the same permission the mapping mutations enforce, so anyone shown this picker can save what it offers. Errors: Throws when the user is not logged in, the workspace has finance disabled, or the user lacks the setup update permission.
getFinanceConsolidatedTrialBalance
A trial balance for a group of GL companies with its intercompany balances eliminated, plus everything it could not eliminate.
glCompanyIds names the group; omitting it consolidates every company the workspace has. asOf bounds the posting date, as the single-company trial balance does. Access: Requires the finance feature and the reports read permission, the same gate every other statement uses. Errors: Throws when the user is not logged in, the workspace has finance disabled, the user lacks the reports read permission, a named company does not exist in the workspace or is one the reader may not open, or the group is omitted and the reader does not hold every company.
getFinanceConsolidatedBalanceSheet
A balance sheet for a group of GL companies with its intercompany balances eliminated, plus everything the consolidation could not eliminate.
glCompanyIds names the group; omitting it consolidates every company the workspace has. asOf bounds the posting date and comparisonAsOf adds the prior column, as the single-company balance sheet does. Access: Requires the finance feature and the reports read permission, the same gate every other statement uses. Errors: Throws when the user is not logged in, the workspace has finance disabled, the user lacks the reports read permission, a named company does not exist in the workspace or is one the reader may not open, or the group is omitted and the reader does not hold every company.
getFinanceConsolidatedProfitLoss
A profit and loss for a group of GL companies with its intercompany balances eliminated, plus everything the consolidation could not eliminate.
glCompanyIds names the group; omitting it consolidates every company the workspace has. startDate and endDate bound the posting date; a date-only endDate covers the whole day, as every other dated report does. Access: Requires the finance feature and the reports read permission, the same gate every other statement uses. Errors: Throws when the user is not logged in, the workspace has finance disabled, the user lacks the reports read permission, a named company does not exist in the workspace or is one the reader may not open, or the group is omitted and the reader does not hold every company.
getFinanceIntercompanyProfitLossActivity
Revenue and cost booked between members of a group, which a consolidation does not eliminate on its own — the candidates an elimination entry is written from.
Lists the non-generated lines of posted journals that span companies, restricted to revenue and cost accounts. glCompanyIds narrows to a group; startDate and endDate bound the posting date. Nothing here is eliminated: whether a line is internal trading or a cost properly borne where it was recorded is a judgment, so this reports and an accountant posts. Access: Requires the finance feature and the reports read permission, the same gate every other statement uses. Errors: Throws when the user is not logged in, the workspace has finance disabled, or the user lacks the reports read permission.
getFinanceSalesTaxAnalysis
Sales tax charged on posted invoices between two dates, by tax code and jurisdiction — what a return is filed from.
startDate and endDate bound the invoice issue date; a date-only endDate covers the whole day, as every other dated report does. glCompanyIds narrows to the companies whose books the invoices posted to; omitting it reports every company. Access: Requires the finance feature and the reports read permission, the same gate every other statement uses. Errors: Throws when the user is not logged in, the workspace has finance disabled, or the user lacks the reports read permission.
getFinanceEliminationEntries
Consolidation adjustments in the workspace, newest first. Access: members of the workspace, in a workspace where finance is enabled. Errors: the workspace is not found, finance is disabled for it, or the caller is not a member.
getFinanceEliminationEntriesCount
Counts elimination entries using the list's filters. Access: same gate as getFinanceEliminationEntries. Errors: the workspace is not found, finance is disabled for it, or the caller is not a member.
getBankConnections
Lists the workspace’s connected bank and accounting providers.
getBankAccounts
Lists bank accounts with current and available balances, currency, and balance freshness. Access: Requires workspace membership and the Finance feature. Errors: Throws when the caller cannot access Finance in the workspace.
getBankTransactions
Read bank transactions, including source changes, pending state and existing match references. A period narrows to its company and clearing dates. No period reads the caller's companies. Access: finance enabled and visibility of the company that holds the transaction. Errors: workspace access denied or an unknown accounting period.
getBankTransactionsCount
Count bank transactions with the same filters and company access as the list. Access: finance enabled and visibility of the transaction company. Errors: workspace access denied or an unknown accounting period.
getBankFeedHealth
Returns the workspace bank-feed connection and synchronization status.
getBankRules
Lists bank transaction rules matching the supplied search and status filters.
getBankRulesCount
Counts bank transaction rules matching the supplied search and status filters.
getVendorTaxProfiles
Lists vendor tax profiles matching the supplied filters.
getTax1099RunsCount
Counts 1099 preparation runs for the selected tax year and search.
getFixedAssets
Lists fixed assets matching the supplied status and search filters.
getFixedAssetsCount
Counts fixed assets matching the supplied status and search filters.
getFinanceApprovalRules
The workspace's approval rules, lowest priority first. Access: members of the workspace, in a workspace where finance is enabled — the same gate the other setup registries use. Reading which rules exist carries no capability of its own. Errors: none beyond the access gate; an unmatched filter returns no rows rather than refusing.
getFinanceApprovalRulesCount
Counts the rules matching the same filters as getFinanceApprovalRules, so the section's total reflects the query its rows came from rather than the page it loaded. Access: same gate as getFinanceApprovalRules. Errors: none beyond the access gate.
getFinanceApprovalRuleApproverCandidates
Workspace members with the record types each could clear an approver step for, sorted by display name. Feeds the rule dialog's approver picker: rule save refuses an approver who cannot clear the selected record types' gates, so the picker filters on this rather than offering every member and surfacing the dead choice as a save error. Access: the finance feature gate plus setupUpdate — the same permission rule save asserts, because derived per-member permission data exists only for rule authoring. Errors: none beyond the access gates.
previewFinanceApprovalRules
The approver steps a document with these attributes would be held by, without writing anything. Empty means no rule matches, which is the auto-approve path. Access: same gate as getFinanceApprovalRules. Errors: none beyond the access gate — an amount matching no rule previews as empty.
getTaxProviderSettings
Lists tax provider settings matching the supplied filters.
getTaxProviderSettingsCount
Counts the tax provider configurations matching the same search and status filters as getTaxProviderSettings, so the section's total reflects the query its rows came from rather than the page it loaded. Access: members of the workspace, in a workspace where finance is enabled. Reading which providers exist carries no capability of its own, the same gate getTaxProviderSettings uses. Errors: none beyond the access gate — an unmatched filter counts zero rather than refusing.
getTaxProviderCalculationLogs
Lists tax-provider calculation logs for a finance source record.
getTaxProviderFilingHandoffs
Lists filing handoffs for a tax provider.
getBankFeedParity
Compare the two feeds for one GL cash account, day by day, over a window.
Access: finance feature access and the setupRead permission, the same gate the bank feed
screen's health read takes, since this answers for the same accounts.
Errors: refuses when the window ends before it starts, when the bank accounts mapped to the GL account state more than one currency, and when any row inside the window states an amount that cannot be read exactly — a total with a silently dropped row is the one answer a parity check must never give.
getFinanceAuditEvents
Lists finance audit events matching the supplied filters, search, and sort order.
getFinanceAuditEventsCount
Counts finance audit events matching the supplied filters and search.
getCashForecastDocuments
Documents contributing to one cash forecast source and period; omit bucketIndex for its total. Access: Finance reports read access for the complete workspace. Errors: Invalid source, period or date; unreadable financial amounts.
getCashForecast
Returns the cash forecast from scheduled receipts, payments, and other cash movements.
getAccountingAllocationRules
Lists the workspace's allocation rules for the Allocation rules section. Search matches what a row displays — the rule name, its basis-type and status labels, and its basis row labels — rather than the stored keys behind them. Access: signed-in members of the workspace with finance report read access. Errors: workspace not found, or finance not enabled for it.
getAccountingAllocationRulesCount
Total allocation rules matching the same filters as getAccountingAllocationRules, for the list's row count. Access: signed-in members of the workspace with finance report read access. Errors: workspace not found, or finance not enabled for it.
previewAccountingAllocationRun
Computes the lines a rule would allocate for a total, without persisting anything, so the run can be reviewed before it exists. Shares the builder createAccountingAllocationRun uses, so the preview is the run. Access: signed-in members of the workspace with finance report read access. Errors: rule not found; the rule's basis total is not positive; or the total amount is not positive.
getAccountingAllocationRuns
Lists allocation runs for the Allocation runs section. Search matches the run's rule name and its displayed status label, resolving the name through the workspace's rules. Access: signed-in members of the workspace with finance report read access. Errors: workspace not found, or finance not enabled for it.
getAccountingAllocationRunsCount
Total allocation runs matching the same filters as getAccountingAllocationRuns, for the list's row count. Access: signed-in members of the workspace with finance report read access. Errors: workspace not found, or finance not enabled for it.
getAdjustingJournalEntriesReport
Lists adjusting journal entries for the selected reporting period or date range.
previewFinanceRevaluationRun
Prices the workspace's open foreign-currency balances at a date without persisting anything, so a revaluation can be reviewed before it exists. Prices every open foreign balance the subledgers hold — customer and vendor invoices, their contra sets credit memos and vendor credits, and unapplied receipt cash sitting in the customer-deposit liability. Shares the builder createFinanceRevaluationRun uses, so the preview is the run. Access: signed-in members of the workspace with finance report read access. Errors: no exchange rate is stored for a currency on or before the date; a document outside the customer-invoice set carries no usable record of the rate and home balance it posted at; an open balance is too small for the rate to carry into a whole base minor unit; a foreign remainder was never parked outside AR; or there is nothing to revalue — including the case where the only open foreign balances are receivables the run could not price, which is refused by its own sentence rather than reported as nothing to revalue. A receivable carrying no usable record is left out of the adjustment and named in unpricedDocuments instead of refusing.
getFinanceRevaluationRuns
Lists stored revaluation runs, newest revaluation date first — the record of what was booked, which is the whole reason a run exists rather than a report parameter. Access: signed-in members of the workspace with finance report read access. Errors: workspace not found, or finance not enabled for it.
getFinanceRevaluationRunsCount
Total revaluation runs matching the same filters as getFinanceRevaluationRuns. Access: signed-in members of the workspace with finance report read access. Errors: workspace not found, or finance not enabled for it.
getMilestoneBillingSchedules
Lists milestone billing schedules matching the supplied workspace and project filters.
getMilestoneBillingSchedulesCount
Counts milestone billing schedules matching the supplied workspace and project filters.
getFinancePayrollAccountOptions
Lists active GL accounts accepted by the selected payroll schedule family, without balances. Access: Requires the finance feature and the permission used to author that family — accounting post for journal entries or purchasing create for vendor bills. Errors: Throws when the user is not logged in, finance is disabled, the family is not supported by payroll setup, or the user lacks that family's authoring permission.
getFinanceRecurringSchedules
Lists recurring finance schedules matching the supplied filters.
getFinanceRecurringSchedulesCount
Counts recurring finance schedules matching the supplied filters.
getFinanceRecurringVendorBillSuggestions
Vendors whose bill history already says what a schedule would, largest amount first.
The cash forecast projects an active schedule's occurrences into its weeks, so a vendor that bills every month and has no schedule is a committed outflow the forecast cannot see. Derived from posted and approved bills issued in the trailing twelve months, in the workspace base unit. Vendors that already have an active vendor-bill schedule are omitted — the forecast holds them already, and a second schedule would double the outflow. Nothing is written here: accepting a suggestion calls createFinanceRecurringSchedule with it. Access: the accounting read permission, the same gate getFinanceRecurringSchedules asserts. Errors: Throws when the user is not logged in, finance is disabled, the user lacks accounting read, or the workspace has no setup profile stating its base money unit.
getFinanceBillableAgreements
Every agreed proposal a client-invoice setup could name, newest agreement first.
Agreed is the mutation's own test — a frozen acceptance snapshot on the proposal — rather than the more forgiving read the proposal surfaces use, so nothing offered here is refused at save. Access: signed-in workspace members with the billing invoice generate permission, matching the schedule and retainer mutations that consume this data. Errors: throws when the caller is not signed in, Finance is disabled, or the caller lacks that permission.
getFinanceNavBadgeCounts
Fast Finance sidebar count badges. Avoids money aggregates and integration health scans.
getFinanceNavBadgeExtras
Deferred Finance sidebar payload: money totals, bank health, setup readiness, and admin signals. asOf sets the opening day for time-sensitive totals.
getFinanceNavBadgeSnapshot
Combined nav badge payload. Prefer getFinanceNavBadgeCounts + getFinanceNavBadgeExtras for faster counts. asOf sets the opening day for time-sensitive totals.
getFinanceHomeDashboard
Every Overview tile in one payload — the whole KPI row plus the Priority workbench queues.
Superseded by the pair below, which Overview reads instead so its cheap tiles stop waiting on the subledger scan. Kept whole and unchanged for stale client bundles: a browser holding the previous bundle across a deploy derives all seven balance tiles from this health array, and narrowing it would have those tiles state absence — "No bank connected" over eighteen accounts — rather than a figure. Remove once no shipped bundle reads it.
Access: Requires the finance feature.
Errors: Throws when the user is not logged in or the workspace has finance disabled.
getFinanceHomeLedger
Overview's posted-ledger half: the Priority workbench queues, and the A/R and A/P control tiles projected from posted journal lines.
One field because it is one read. The receivable projection prices both the A/R tile and the Open accounts receivable queue row, and splitting them into two reads lets a posting land between them and leave one screen stating two receivable positions.
Writes: creates the workspace's finance setup profile on first use.
Access: Requires the finance feature.
Errors: Throws when the user is not logged in or the workspace has finance disabled.
getFinanceHomeBalances
Overview's document-collection tiles: cash, the billing pipeline, WIP, unapplied retainers and deferred revenue — counts and sums over indexed document filters, plus the WIP asset's ledger position.
Separate from getFinanceHomeLedger so these paint at their own speed rather than at the speed of the subledger scan beside them. The WIP bucket is absent, not zero, on a workspace that names no WIP asset account: no position exists to state.
Writes: creates the workspace's finance setup profile on first use.
Access: Requires the finance feature.
Errors: Throws when the user is not logged in or the workspace has finance disabled.
getFinanceQueueCensus
Every Finance work queue with its count, money total, age, and capability answer for the viewer. One read for the Queues surface and its badges. Writes: creates the workspace's finance setup profile on first use.
getFinanceTieOutHealth
Continuous AR / AP / bank / WIP / fixed-asset tie-out health, rendered on Overview and inside the close.
Takes no as-of argument on purpose: four of the five subledgers are current-state reads (an invoice balance, a receipt's unapplied amount, a WIP line's billed state, an asset's posted schedule) that cannot be reconstructed at a past date, so dating only the ledger side would manufacture differences that are pure date skew. Every rail reports the stamp it was actually measured at instead.
getInvoiceAdjustments
Every receipt written against one invoice, newest last, so the drafting surface can show each edited line beside what was done to it.
getFinanceVendorBill
One vendor bill, by id — the detail behind a Bills row, and what the lifecycle controls act on.
getFinanceWorkamajigProjectMatches
Lists the projects a Workamajig historical import holds for review, with what the importer decided for each and the Hive projects they can see whose name matches its name or number. Access: the member who started the import, with Finance setup edit access. Errors: a run that is not a Workamajig historical import.
getFinanceSourceConnections
Lists operating-source health without exposing credentials or restricted source payloads. Access: Finance setup readers. Errors: workspace access or setup-read permission is missing.
getStripeFinanceReviewRows
Lists available Stripe charge rows using a review-safe typed projection, never raw payloads. Writes: quarantines rows that cannot build a draft proposal and re-derives the connection's review state from the rows that remain. Access: Finance accounting readers. Errors: workspace access or accounting-read permission is missing.
getFinanceAssignableUserOptions
Searches the members a finance record's owner or reviewer may be, a page at a time, by name or address. search narrows on any part of either; omitting it returns the first page alphabetically. Eligibility is evaluated on the page of matches rather than stored, and is the same rule assignFinanceOwnerReviewer enforces per record — deliberately not the workspace's finance surface-access list, which that mutation never consults and which would hide members it accepts. Access: Requires the finance feature and the setup update permission — the permission assignFinanceOwnerReviewer enforces, so anyone shown this picker can assign what it offers. Errors: Throws when the user is not logged in, the workspace has finance disabled, or the user lacks the setup update permission.
getFinanceRetainerAgreements
Lists retainer agreements, newest first, with their next invoice and remaining-period state. Search matches the retainer name or the client name shown in the row. Access: signed-in workspace members with Finance access, limited to companies they may read. Errors: throws when the caller is not signed in or Finance is disabled; unmatched filters return no rows.
getFinanceRetainerAgreementsCount
Counts agreements matching getFinanceRetainerAgreements' search and status filters. Access: same gate and company scope as getFinanceRetainerAgreements. Errors: same access errors as getFinanceRetainerAgreements.
getFinanceRetainerAgreementInvoices
Lists invoices generated from one retainer agreement, newest issue date first. Access: signed-in workspace members with Finance access who may read the agreement's company. Errors: throws when the caller is not signed in or Finance is disabled; an absent or inaccessible agreement returns no invoices.
getFinanceInvestigation
Read the latest checkpoint of an investigation. Access: accounting read and access to its company and accounting period. Errors: investigation not found or access denied.
getFinanceInvestigationHistory
Read immutable checkpoints, newest first. Paginate to inspect the full history. Access: accounting read and access to the investigation's company and period. Errors: investigation not found or access denied.
getFinanceInvestigations
Read the latest checkpoint for each investigation in a period, newest investigation first. Access: accounting read and access to the period's company. Errors: period not found or access denied.
getFinanceInvestigationsCount
Count investigations in a period, for complete-population pagination. Access: accounting read and access to the period's company. Errors: period not found or access denied.
getGoogleDriveFiles
Searches files in the connected Google Drive account.
getGoogleDriveFileContent
Gets the content of a file from the connected Google Drive account.
getResourcingBlockedTime
Meeting-backed blocked time for Resourcing. Returns read-only meeting blocks from synced meeting docs for requested workspace users.
getEmailThread
Fetch all messages for a provider mail thread by thread ID. Unlike getEmails, this does not depend on the currently loaded mailbox page, so draft threads can render their prior context.
getEmails
Get emails from the user's mailbox with support for pagination. If there are more emails available beyond the current page, the response will include a "nextPageToken". To retrieve the next batch of results, call "getEmails" again using the same filters and pass the returned "nextPageToken".
getCrmPipelines
Lists workspace CRM pipelines in configured order. Access: workspace members with CRM access.
getOpportunityStats
Gets aggregate counts for CRM opportunities matching supplied filters.
getOpportunityPipelineSummary
Breaks the opportunities matching the filters into forecast buckets (open, commit, most likely, best case, closed won, closed lost), each with a count and summed amount. Use it for a pipeline or forecast overview; getOpportunityStats returns only overall totals.
Access: workspace members with CRM access.
getOpportunityRepPerformance
Per-owner sales performance: open count, pipeline value, won and lost counts, win rate, and new pipeline created, sorted by pipeline value, plus workspace totals. When both periodStart and periodEnd are set, won/lost use close date and new pipeline uses creation date within that window.
Access: workspace members with CRM access.
getCrmPipelineMapReport
Aggregates open opportunity value by account for the CRM pipeline map. Access: workspace members with CRM read access. Errors: unauthenticated, inaccessible workspace, disabled CRM, or missing CRM permission.
getOpportunities
List CRM opportunities. Each node includes owner (workspace member) and account when selected in the query.
getOpportunityMaterials
Lists the files and folders linked to an opportunity as materials (proposals, decks, briefs), with their file-library nodes.
Access: users with access to the opportunity.
previewOpportunityLinesFromPlanningProject
Dry-run of building an estimate from a planning project: returns the line drafts without writing them or linking the project.
getOpportunityCommercials
Commercial read-out for one opportunity: pipeline and weighted amount, probability, forecast category, line count, SOW total and cost, and the delivery baseline of its kicked-off project, plus a nudge when the plan lags the latest agreed proposal.
Access: users with access to the opportunity.
getAccountCommercials
Rolls up commercials across all of an account's opportunities: pipeline, weighted, and SOW totals, plus delivery baselines per kicked-off project (kept separate, never summed).
Access: users with access to the account.
getCatalogRecordAvailability
Sold/available inventory for catalog records. Sold counts line quantities from accepted proposals only; capacity is read from each record's configured field.
getSequenceStepRuns
Lists execution steps for a CRM sequence enrollment.
getSequenceEnrollmentPreparedEmails
Each email of one sequence enrollment as the person will get it, written ahead of its send. Reads only: the agent does not run. Access: Workspace members with CRM access. Errors: Throws when the enrollment does not exist or CRM access is denied.
getSequenceCalls
Lists the calls a sequence's call steps placed, newest first, with how many were picked up, went to voicemail or booked a session. Transcripts are read with getSequenceCallTranscript. Access: Workspace members with CRM access.
getSequenceCallTranscript
Gets the transcript of a call placed by the sequence. Access: Workspace members with CRM access.
getActionableCallMailSteps
Returns ready CallMail work owned by the signed-in user. Access: Workspace members with CRM access. Errors: The caller is unauthenticated or lacks CRM access.
getCrmSenderMailboxes
Mailbox approval is unavailable during the S1c rollback. Retained for existing clients. Access: workspace members with CRM access. Errors: unauthenticated, CRM access denied, or mailbox approval unavailable.
getMyCrmSenderAccess
Returns an empty list while mailbox approval is unavailable during the S1c rollback. Access: any signed-in user. Errors: unauthenticated.
getHolidayCalendars
Lists holiday calendars available in a Hive workspace.
getAccessibleHttpConnections
Lists HTTP connections the caller can access in a workspace, including owned, directly shared, and workspace-wide connections. Use the results to identify reusable API connections.
getNativeOAuthProviders
Hive-managed OAuth apps that can be connected as HTTP connections.
getLabels
Lists workspace labels by IDs, name text, or both, with cursor pagination. Combining IDs and text returns labels that satisfy both filters. Text search returns at most 20 results; refine the query when the desired label is absent.
getAccessibleMcpServers
Lists MCP servers the caller owns or can access in a workspace, optionally filtered by ID. Use the results to identify reusable service connections.
getMeetings
Get meetings matching filter criteria. Returns only meetings you can read. A meeting is readable when you are its organizer or an attendee, when it is linked to a CRM record and you have CRM access, or when you hold a meetingUserData doc for it (your own, or one shared with you by name); 'everyone' sharing grants nothing. At least one filter must be provided.
getMeetingMergedTranscript
Merged transcript across all readable MeetingUserData docs for a meeting (multi-leader sessions). Deduped by transcriptId, ordered by server seq. Returns only meetings you can read. A meeting is readable when you are its organizer or an attendee, when it is linked to a CRM record and you have CRM access, or when you hold a meetingUserData doc for it (your own, or one shared with you by name); 'everyone' sharing grants nothing.
getMeetingUserDataList
Lists the caller's Sidekick meeting records, including available transcripts, goals, and summaries, newest first. Optional search matches titles, attendees, and summary text.
getMeetingUserDataByDeal
Get meeting user data linked to a Hive CRM Opportunity.
Resolves linked meetings via linked_meeting CrmAssociations from the
opportunity and returns matching MeetingUserData docs.
scheduledMessages
Lists the caller's own scheduled chat messages in one chat (containerId is the group ID) that are still pending or failed to send, latest send time first, up to 101.
Access: workspace members who can see the chat. Errors: no workspace access; chat not found.
messagesEasySearch
Searches through messages in a workspace
Very useful for searching through existing private conversations or chat groups. Supports search by the group type or id. Could return total count of messages.
Access: Requires user access to the workspace, groups if used.
getMessages
Lists or searches messages in chats the caller can access. A groupId scopes results to that chat or thread; omitting groupId requires text and searches accessible chats. Parent-chat results exclude thread replies, which are retrieved newest-first using threadId as groupId. Use findChats with member IDs to resolve a person's chat before reading it. Requires membership in the chat or, for threads, its parent chat.
chatGroupLibrary
Returns media, files, and links shared in a group chat, grouped by category.
Access: Requires user membership in the workspace and the group.
newsCategories
List custom news categories for a workspace.
Access: Requires user access to the workspace.
getNote
Get a note by ID
Access: Requires user access to the note
Parameters:
- noteId: The ID of the note to retrieve
Returns: The requested note
notebooks
Lists notebooks the caller can access, with title search, workspace or project filters, ownership filters, and pagination.
adminProductVisual
Returns one Highway Studio product visual job. Access: Authenticated Hive super admins. Errors: unauthenticated, unauthorized, invalid or missing job.
posts
List posts for a workspace, newest first, excluding soft-deleted posts.
Access: Requires user access to the workspace.
getForecast
Forecast for projects or a goal, computed from its own history and checked against that history. Completion (projects): when the open actions will be done and how many will be done by targetDate. Goal pace (Number or Actions goal): the value projected at the goal end date against the target. Returns status insufficientData or unreliable, with a plain-language reason, when the history cannot support a forecast.
Access: Requires access to every project (only actions the user can see count) or to the goal.
postComments
List comments for the given posts, ascending by createdAt, excluding soft-deleted comments.
Access: Requires user access to the workspace.
getProposal
Returns a proposal: its title and status, the buyer's requirements, the questions Hive left open (proposalPlan.inputRequests), the latest draft (generatedArtifact, whose notes say what it changed) and whether a draft is running (documentGenerationRun). What the draft still asks the proposal owner is in its Word comments: read them with getProposalComments. Access: caller must have CRM access to the proposal's workspace.
getProposalComments
Returns the comments in the proposal's Word document as it is now, with their replies and the text each comment is attached to. Hive's drafts ask the proposal owner for what they still need as comments, so the open ones are the document's open questions. Returns an empty list when the proposal has no document yet. Access: caller must have CRM access to the proposal's workspace.
getPriorityLevels
Lists priority levels for a workspace, optionally filtered by form, action, included IDs, or excluded IDs. Requires workspace access.
getProjects
Lists projects the caller can access, with search, filters, sorting, and cursor pagination. Supports specific IDs, ownership, hierarchy, archive and template state, and custom-field filters.
getQuickbooksPurchaseOrderAttachments
Lists attachments on a QuickBooks purchase order.
searchQuickbooksItems
Searches items in the caller's connected QuickBooks company by item ID, exact name, or fully qualified name. Prefer itemId when available, such as a purchase-order ItemRef value.
searchQuickbooksPurchaseOrders
List or search QuickBooks purchase orders for the current user's connected company. Paginate with startPosition (1-based) and first (page size, max 100). Optionally filter by exact DocNumber.
getResourceAssignments
Lists resource assignments by workspace, date range, project, or resource. Use returned assignment IDs for subsequent updates.
workspacePlaceholders
Get all resource placeholders for a workspace
Access: Requires user access to the workspace
Parameters:
- workspaceId: The ID of the workspace
- specificIds: Array of specific resource placeholder IDs to return
Returns: Array of ResourcePlaceholder objects
getResourceTags
Lists resourcing roles and custom user tags configured in a workspace, with type, text, ID, and cursor-pagination filters. Use the returned _id as resourceTagId when querying or changing user and placeholder tag assignments.
getSlackChannels
List public and private Slack channels in the user's connected workspace. Use before reading or sending messages when you need a channel ID. Access: Requires Slack connected in Apps. Errors when Slack is not connected.
getSlackDms
List Slack direct and group message conversations for the connected user, including bot DMs. Use with getSlackChannels when choosing where to read or post. Access: Requires Slack connected in Apps.
getSlackMessages
Read recent top-level messages from a Slack channel or DM using the Hive bot. Returns channel/DM-level messages only — replies inside a thread are not included. Call getSlackChannels or getSlackDms first to obtain channelId. Access: Requires Slack connected in App Library, user access to the conversation, and Hive bot added to it. Reconnect Slack if the bot lacks history permissions.
getSlackMyInfo
Get raw Slack user info for the current user.
Access: Requires an authenticated user with a connected Slack account. Errors: Throws when the user is not logged in or Slack user info cannot be retrieved.
getStatusesForWorkspace
List workspace project status definitions (id, name, color) for Project Navigator / portfolio status. Call before insertProjectStatusUpdate or bulkUpdateProjectStatuses to validate status labels.
Access: Requires workspace access
getTimeCategories
List workspace time categories (e.g. Capex, Opex). Match user-mentioned names against the returned name field client-side. Pass projectId when categories are project-scoped so project-specific categories are included. Categories with timeOff: true are PTO; their hours report as leave, not worked time.
getUserTimeEntries
Usage: Allows user to pull time entries for the specified userId in a given time range
Access: Requires workspace admin access
Errors: Returns an error if not a workspace administrator.
getMyTimeEntries
Lists the authenticated caller's time entries within a date range in an accessible workspace.
getTimers
Get timers for the current user in a workspace
Access: Requires user to be logged in and have access to the workspace
getMyTimesheets
Used for the "Timesheet" tab in "Timesheets" app.
Access: It requires user access.
Errors: Returns [] if doesn't have access or user with requested userId doesn't exist.
getTimesheetsToApprove
Used for the "My approvals" tab in "Timesheets" app.
Access: It requires user access.
Errors: Returns [] if doesn't have access or user with requested userId doesn't exist
getTimesheetsToReview
Lists other members' timesheets the caller can review, newest week first. Scope includes managed users, owned projects that use project-owner approval, or the whole workspace for admins; the caller's own timesheets are excluded.
getUserTimesheets
Used for the "Manage" tab in "Timesheets" app.
Access: Requires workspace admin access
Errors: Returns [] if not a workspace admin.
getSubmittedTimesheets
Paginated submitted timesheets for every teammate in one exact week. Used for workspace-wide bulk edits in the Timesheets Manage tab. Access: Requires workspace admin access. Errors: Returns an empty connection if the caller is not a workspace admin.
getTimesheetApprovals
paginated resolver for the timesheet approval log.
Used for approvals log in "Timesheets" app.
Access: It has admin access.
Errors: Returns empty paginated response if is not workspace admin.
getHistoricalTimesheets
Used for edit log in "Manage" tab in "Timesheets" app.
Access: It requires user access.
Errors: Returns [] if not logged in or doesn't have access to workspace.
getTimesheetComments
Used for querying timesheet comments in timesheet comment modal in "timesheet" tab in "Timesheets" app.
Access: It requires user access.
Errors: Returns specific expected errors if: timesheet not found, user doesn't have access to workspace
getUnsubmittedTimesheetSummaries
Returns selected-week logged and planned totals for visible unsubmitted timesheet users.
Access: Workspace members. Workspace admins receive totals for requested members. Non-admins receive totals only for users they manage or reach through an owned project.
Hours cover every unsubmitted, non-history timesheet a requested member holds in the selected week, for admins and for the caller's direct reports. Users the caller reaches only through an owned project get null hours rather than a total that omits their other containers. Time-off allocations count toward Planned only for admins and direct reports, so leave stays private from project-owner approvers. Planned follows the workspace timesheet prefill source. Allocated, tracked, and estimated time include only projects the caller can access.
Errors: Returns [] if the caller is not logged in or cannot access the workspace. Throws if more than 200 user IDs are requested or the date range exceeds seven days.
userFilter
Returns user filter for a view layout (e.g. dashboardWidget pivot columns keyed by widget actionViewId). Read before updateUserFilterV2 when editing pivot formulas.
getUserTags
Lists role and custom-tag assignments for users and resource placeholders. Supports filtering by resource, tag ID, or tag type. Call getResourceTags first to resolve resourceTagId.
webhooks
Get webhooks for a workspace with pagination, search, and sort. Admin-only.
getResourceAvailability
Calculates daily free working hours for users or placeholders over a date range. Availability subtracts committed work, meetings, and time off from capacity and is clamped at zero. Zero means unavailable because of schedule, leave, capacity, employment dates, or workspace status. Use for workload and capacity questions, not meeting scheduling.
getWorkflowsForWorkspacePaginated
Get all action templates for a workspace
getWorkspace
Get a workspace by ID
Access: Requires workspace access or be a member of the workspace
Parameters:
- workspaceId: The ID of the workspace to retrieve
Returns: The requested workspace
getWorkspaceXeroSyncStatus
Get workspace Xero Finance sync owner/status without exposing tokens.
getUsersWorkspaces
Get the current user's workspaces, including accepted workspaces and primary workspace with names.
Access: Requires user authentication.
Returns: The user's accepted workspaces and primary workspace, each with ID and name.
PurchaseOrderStatus
QuickbooksAccount