> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amdital.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP Tool Reference

> Browse all AmDital MCP tools with input/output schemas and usage examples.

Every tool available on the AmDital MCP server. Your MCP client auto-discovers these via `tools/list` at connection time. All tools are workspace-scoped — you only access data in your own workspace.

<Note>
  Tool availability depends on your scope: `read:<module>` lets you call read-only tools, `write:<module>` (which implies read) lets you call both read and write tools, and `delete:<module>` lets you call delete tools. See [Authentication](/mcp/auth) for scope details.
</Note>

## CRM (46 tools: 20 read, 16 write, 10 delete)

### `crm.companies.delete` — delete:crm — destructive

Delete a company. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.companies.get` — read:crm — read-only

Get a single company by ID.

### `crm.companies.list` — read:crm — read-only

List CRM companies in the current workspace, with optional name search.

### `crm.contacts.create` — write:crm

Create a contact. Fails with "duplicate" if a contact with the same email already exists.

### `crm.contacts.delete` — delete:crm — destructive

Permanently delete a contact. This cannot be undone.

### `crm.contacts.get` — read:crm — read-only

Get a single contact by ID, including its linked company details.

### `crm.contacts.list` — read:crm — read-only

List CRM contacts in the current workspace, with optional name search.

### `crm.contacts.update` — write:crm

Update a contact's name, email, phone, title, company or notes.

### `crm.customFieldDefs.create` — write:crm

Create a new CRM custom field definition.

### `crm.customFieldDefs.delete` — delete:crm — destructive

Delete a CRM custom field definition. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.customFieldDefs.get` — read:crm — read-only

Get a single CRM custom field definition by ID.

### `crm.customFieldDefs.list` — read:crm — read-only

List CRM custom field definitions in the current workspace.

### `crm.customFieldDefs.update` — write:crm

Update an existing CRM custom field definition's fields.

### `crm.deals.delete` — delete:crm — destructive

Delete a deal. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.deals.get` — read:crm — read-only

Get a single deal by ID.

### `crm.deals.list` — read:crm — read-only

List CRM deals in the current workspace, with optional stage/contact/company filters.

### `crm.leadRoutes.create` — write:crm

Create a new lead routing rule.

### `crm.leadRoutes.delete` — delete:crm — destructive

Delete a lead routing rule. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.leadRoutes.get` — read:crm — read-only

Get a single lead routing rule by ID.

### `crm.leadRoutes.list` — read:crm — read-only

List lead routing rules in the current workspace.

### `crm.leadRoutes.update` — write:crm

Update an existing lead routing rule's fields.

### `crm.leads.create` — write:crm

Create a new CRM lead in the current workspace.

### `crm.leads.delete` — delete:crm — destructive

Delete a lead. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.leads.get` — read:crm — read-only

Get a single lead by ID.

### `crm.leads.list` — read:crm — read-only

List CRM leads in the current workspace, with optional stage/source filter and search.

### `crm.leads.update` — write:crm

Update an existing CRM lead's fields (stage, notes, value, etc.).

### `crm.pipelines.create` — write:crm

Create a new pipeline.

### `crm.pipelines.delete` — delete:crm — destructive

Delete a pipeline. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.pipelines.get` — read:crm — read-only

Get a single pipeline by ID.

### `crm.pipelines.list` — read:crm — read-only

List pipelines in the current workspace.

### `crm.pipelines.update` — write:crm

Update an existing pipeline's fields.

### `crm.products.create` — write:crm

Create a new CRM product.

### `crm.products.delete` — delete:crm — destructive

Delete a CRM product. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.products.get` — read:crm — read-only

Get a single CRM product by ID.

### `crm.products.list` — read:crm — read-only

List CRM products in the current workspace.

### `crm.products.update` — write:crm

Update an existing CRM product's fields.

### `crm.sequenceEnrollments.create` — write:crm

Create a new sequence enrollment.

### `crm.sequenceEnrollments.delete` — delete:crm — destructive

Delete a sequence enrollment. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.sequenceEnrollments.get` — read:crm — read-only

Get a single sequence enrollment by ID.

### `crm.sequenceEnrollments.list` — read:crm — read-only

List sequence enrollments in the current workspace.

### `crm.sequenceEnrollments.update` — write:crm

Update an existing sequence enrollment's fields.

### `crm.sequences.create` — write:crm

Create a new CRM sequence.

### `crm.sequences.delete` — delete:crm — destructive

Delete a CRM sequence. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `crm.sequences.get` — read:crm — read-only

Get a single CRM sequence by ID.

### `crm.sequences.list` — read:crm — read-only

List CRM sequences in the current workspace.

### `crm.sequences.update` — write:crm

Update an existing CRM sequence's fields.

## Projects & tasks (25 tools: 14 read, 5 write, 6 delete)

### `work.chat_channels.create` — write:work

Create a new chat channel.

### `work.chat_channels.delete` — delete:work — destructive

Delete a chat channel. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `work.chat_channels.get` — read:work — read-only

Get a single chat channel by ID.

### `work.chat_channels.list` — read:work — read-only

List chat channels in the current workspace.

### `work.chat_channels.update` — write:work

Update an existing chat channel's fields.

### `work.chat_messages.create` — write:work

Create a new chat message.

### `work.chat_messages.delete` — delete:work — destructive

Delete a chat message. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `work.chat_messages.get` — read:work — read-only

Get a single chat message by ID.

### `work.chat_messages.list` — read:work — read-only

List chat messages in the current workspace.

### `work.chat_messages.update` — write:work

Update an existing chat message's fields.

### `work.files.delete` — delete:work — destructive

Delete a work file. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `work.files.get` — read:work — read-only

Get a single work file by ID.

### `work.files.list` — read:work — read-only

List work files in the current workspace.

### `work.files.update` — write:work

Update an existing work file's fields.

### `work.milestones.get` — read:work — read-only

Get a single milestone by ID.

### `work.milestones.list` — read:work — read-only

List milestones in the current workspace.

### `work.projects.delete` — delete:work — destructive

Delete a project. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `work.projects.get` — read:work — read-only

Get a single project by ID.

### `work.projects.list` — read:work — read-only

List projects in the current workspace, with optional status filter.

### `work.sprints.delete` — delete:work — destructive

Delete a sprint. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `work.sprints.get` — read:work — read-only

Get a single sprint by ID.

### `work.sprints.list` — read:work — read-only

List sprints in the current workspace, with optional project/status filter.

### `work.tasks.delete` — delete:work — destructive

Delete a task. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `work.tasks.get` — read:work — read-only

Get a single task by ID, returning the full row including description and custom fields.

### `work.tasks.list` — read:work — read-only

List tasks in the current workspace, with optional project/assignee/status filter.

## Time tracking (4 tools: 2 read, 2 write)

### `time.entries.create` — write:time

Log hours against a task in the current workspace, as the connected user. date is YYYY-MM-DD.

### `time.entries.list` — read:time — read-only

List time entries in the current workspace, with optional date/project filter.

### `time.entries.update` — write:time

Update one of the connected user's own time entries (task, date, hours, description, billable).

### `time.timesheets.list` — read:time — read-only

List team timesheets in the current workspace, with optional status filter.

## Marketing (13 tools: 6 read, 4 write, 3 delete)

### `marketing.campaigns.delete` — delete:marketing — destructive

Delete a campaign. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `marketing.campaigns.get` — read:marketing — read-only

Get a single campaign by ID.

### `marketing.campaigns.list` — read:marketing — read-only

List marketing campaigns in the current workspace.

### `marketing.emailTemplates.create` — write:marketing

Create a new email template.

### `marketing.emailTemplates.delete` — delete:marketing — destructive

Delete a email template. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `marketing.emailTemplates.get` — read:marketing — read-only

Get a single email template by ID.

### `marketing.emailTemplates.list` — read:marketing — read-only

List email templates in the current workspace.

### `marketing.emailTemplates.update` — write:marketing

Update an existing email template's fields.

### `marketing.forms.create` — write:marketing

Create a new marketing form.

### `marketing.forms.delete` — delete:marketing — destructive

Delete a marketing form. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `marketing.forms.get` — read:marketing — read-only

Get a single marketing form by ID.

### `marketing.forms.list` — read:marketing — read-only

List marketing forms in the current workspace.

### `marketing.forms.update` — write:marketing

Update an existing marketing form's fields.

## HR (36 tools: 20 read, 10 write, 6 delete)

### `hrms.arrears.get` — read:hrms — read-only

Get a single arrears record by ID.

### `hrms.arrears.list` — read:hrms — read-only

List one employee's arrears records (employeeId required).

### `hrms.complianceRecords.create` — write:hrms

Create a new compliance record.

### `hrms.complianceRecords.delete` — delete:hrms — destructive

Delete a compliance record. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `hrms.complianceRecords.get` — read:hrms — read-only

Get a single compliance record by ID.

### `hrms.complianceRecords.list` — read:hrms — read-only

List compliance records in the current workspace.

### `hrms.complianceRecords.update` — write:hrms

Update an existing compliance record's fields.

### `hrms.departments.create` — write:hrms

Create a new department.

### `hrms.departments.delete` — delete:hrms — destructive

Deactivate a department (soft delete: status set to inactive).

### `hrms.departments.get` — read:hrms — read-only

Get a single department by ID. Open to every workspace member (the permission key gates nobody); do not rely on it to restrict access.

### `hrms.departments.list` — read:hrms — read-only

List departments in the current workspace. Open to every workspace member (the permission key gates nobody); do not rely on it to restrict access.

### `hrms.departments.update` — write:hrms

Update an existing department's fields.

### `hrms.employeeBonuses.get` — read:hrms — read-only

Get a single employee bonus by ID.

### `hrms.employeeBonuses.list` — read:hrms — read-only

List one employee's bonuses (employeeId required).

### `hrms.employees.create` — write:hrms

Create a new employee.

### `hrms.employees.delete` — delete:hrms — destructive

Delete a employee. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `hrms.employees.get` — read:hrms — read-only

Get a single employee by ID. Open to every workspace member (the permission key gates nobody); managers only see their own department.

### `hrms.employees.list` — read:hrms — read-only

List employees in the current workspace. Open to every workspace member (the permission key gates nobody); managers only see their own department.

### `hrms.leaveRequests.delete` — delete:hrms — destructive

Delete a leave request. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `hrms.leaveRequests.get` — read:hrms — read-only

Get a single leave request by ID.

### `hrms.leaveRequests.list` — read:hrms — read-only

List leave requests in the current workspace.

### `hrms.leaveRequests.update` — write:hrms

Update an existing leave request's fields.

### `hrms.payrollRuns.get` — read:hrms — read-only

Get a single payroll run by ID.

### `hrms.payrollRuns.list` — read:hrms — read-only

List payroll runs in the current workspace.

### `hrms.performanceReviews.create` — write:hrms

Create a performance review. The calling user is recorded as the reviewer.

### `hrms.performanceReviews.delete` — delete:hrms — destructive

Delete a performance review. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `hrms.performanceReviews.get` — read:hrms — read-only

Get a single performance review by ID.

### `hrms.performanceReviews.list` — read:hrms — read-only

List performance reviews in the current workspace.

### `hrms.performanceReviews.update` — write:hrms

Update an existing performance review's fields.

### `hrms.roles.get` — read:hrms — read-only

Get a single role by ID.

### `hrms.roles.list` — read:hrms — read-only

List roles in the current workspace.

### `hrms.shifts.create` — write:hrms

Create a new shift.

### `hrms.shifts.delete` — delete:hrms — destructive

Deactivate a shift (soft delete: status set to inactive).

### `hrms.shifts.get` — read:hrms — read-only

Get a single shift by ID. Open to every workspace member (the permission key gates nobody); do not rely on it to restrict access.

### `hrms.shifts.list` — read:hrms — read-only

List shifts in the current workspace. Open to every workspace member (the permission key gates nobody); do not rely on it to restrict access.

### `hrms.shifts.update` — write:hrms

Update an existing shift's fields.

## Learning (18 tools: 8 read, 6 write, 4 delete)

### `lms.courses.delete` — delete:lms — destructive

Delete a course. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `lms.courses.get` — read:lms — read-only

Get a single course by ID.

### `lms.courses.list` — read:lms — read-only

List courses in the current workspace.

### `lms.enrollments.create` — write:lms

Create a new enrollment.

### `lms.enrollments.delete` — delete:lms — destructive

Delete a enrollment. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `lms.enrollments.get` — read:lms — read-only

Get a single enrollment by ID.

### `lms.enrollments.list` — read:lms — read-only

List course enrollments in the current workspace, optionally filtered by course.

### `lms.enrollments.update` — write:lms

Update an existing enrollment's fields.

### `lms.lessons.create` — write:lms

Create a new lesson.

### `lms.lessons.delete` — delete:lms — destructive

Delete a lesson. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `lms.lessons.get` — read:lms — read-only

Get a single lesson by ID.

### `lms.lessons.list` — read:lms — read-only

List lessons in the current workspace, optionally filtered by module.

### `lms.lessons.update` — write:lms

Update an existing lesson's fields.

### `lms.modules.create` — write:lms

Create a new course module.

### `lms.modules.delete` — delete:lms — destructive

Permanently delete a course module and every lesson in it. This cannot be undone.

### `lms.modules.get` — read:lms — read-only

Get a single course module by ID.

### `lms.modules.list` — read:lms — read-only

List course modules in the current workspace, optionally filtered by course.

### `lms.modules.update` — write:lms

Update an existing course module's fields.

## Recruitment (17 tools: 8 read, 5 write, 4 delete)

### `recruitment.applicants.delete` — delete:recruitment — destructive

Delete a applicant. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `recruitment.applicants.get` — read:recruitment — read-only

Get a single applicant by ID.

### `recruitment.applicants.list` — read:recruitment — read-only

List applicants in the current workspace, with optional job posting filter.

### `recruitment.applicants.update` — write:recruitment

Update an existing applicant's fields.

### `recruitment.interviews.create` — write:recruitment

Create a new interview.

### `recruitment.interviews.delete` — delete:recruitment — destructive

Delete a interview. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `recruitment.interviews.get` — read:recruitment — read-only

Get a single interview by ID.

### `recruitment.interviews.list` — read:recruitment — read-only

List interviews in the current workspace, optionally filtered by applicant.

### `recruitment.interviews.update` — write:recruitment

Update an existing interview's fields.

### `recruitment.jobPostings.delete` — delete:recruitment — destructive

Delete a job posting. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `recruitment.jobPostings.get` — read:recruitment — read-only

Get a single job posting by ID.

### `recruitment.jobPostings.list` — read:recruitment — read-only

List job postings in the current workspace.

### `recruitment.scorecards.create` — write:recruitment

Create a new scorecard.

### `recruitment.scorecards.delete` — delete:recruitment — destructive

Delete a scorecard. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `recruitment.scorecards.get` — read:recruitment — read-only

Get a single scorecard by ID.

### `recruitment.scorecards.list` — read:recruitment — read-only

List scorecards in the current workspace.

### `recruitment.scorecards.update` — write:recruitment

Update an existing scorecard's fields.

## Finance (56 tools: 23 read, 21 write, 12 delete)

### `finance.accounts.create` — write:finance

Create a new account.

### `finance.accounts.delete` — delete:finance — destructive

Delete a account. Soft delete: the record is hidden from lists and lookups.

### `finance.accounts.get` — read:finance — read-only

Get a single account by ID.

### `finance.accounts.list` — read:finance — read-only

List accounts in the current workspace.

### `finance.accounts.update` — write:finance

Update an existing account's fields.

### `finance.budgets.create` — write:finance

Create a new budget.

### `finance.budgets.delete` — delete:finance — destructive

Delete a budget. Soft delete: the record is hidden from lists and lookups.

### `finance.budgets.get` — read:finance — read-only

Get a single budget by ID.

### `finance.budgets.list` — read:finance — read-only

List budgets in the current workspace.

### `finance.budgets.update` — write:finance

Update an existing budget's fields.

### `finance.estimates.list` — read:finance — read-only

List estimates in the current workspace.

### `finance.expenseCategories.create` — write:finance

Create a new expense category.

### `finance.expenseCategories.delete` — delete:finance — destructive

Delete a expense category. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.expenseCategories.list` — read:finance — read-only

List expense categories in the current workspace. Open to every workspace member (the permission key gates nobody); do not rely on it to restrict access.

### `finance.expenseCategories.update` — write:finance

Update an existing expense category's fields.

### `finance.expenses.delete` — delete:finance — destructive

Delete a expense. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.expenses.get` — read:finance — read-only

Get a single expense by ID.

### `finance.expenses.list` — read:finance — read-only

List expenses in the current workspace.

### `finance.expenses.update` — write:finance

Update an existing expense's fields.

### `finance.invoices.delete` — delete:finance — destructive

Delete a invoice. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.invoices.get` — read:finance — read-only

Get a single invoice by ID.

### `finance.invoices.list` — read:finance — read-only

List invoices in the current workspace.

### `finance.invoices.update` — write:finance

Update an existing invoice's fields.

### `finance.payments.create` — write:finance

Create a new payment.

### `finance.payments.delete` — delete:finance — destructive

Delete a payment. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.payments.get` — read:finance — read-only

Get a single payment by ID.

### `finance.payments.list` — read:finance — read-only

List payments in the current workspace.

### `finance.payments.update` — write:finance

Update an existing payment's fields.

### `finance.products.create` — write:finance

Create a new product.

### `finance.products.delete` — delete:finance — destructive

Delete a product. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.products.get` — read:finance — read-only

Get a single product by ID.

### `finance.products.list` — read:finance — read-only

List products in the current workspace.

### `finance.products.update` — write:finance

Update an existing product's fields.

### `finance.purchaseOrders.create` — write:finance

Create a new purchase order.

### `finance.purchaseOrders.delete` — delete:finance — destructive

Delete a purchase order. Soft delete: the record is hidden from lists and lookups.

### `finance.purchaseOrders.get` — read:finance — read-only

Get a single purchase order by ID.

### `finance.purchaseOrders.list` — read:finance — read-only

List purchase orders in the current workspace.

### `finance.purchaseOrders.update` — write:finance

Update an existing purchase order's fields.

### `finance.recurringExpenses.delete` — delete:finance — destructive

Delete a recurring expense. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.recurringExpenses.get` — read:finance — read-only

Get a single recurring expense by ID.

### `finance.recurringExpenses.list` — read:finance — read-only

List recurring expenses in the current workspace.

### `finance.recurringExpenses.update` — write:finance

Update an existing recurring expense's fields.

### `finance.taxRates.create` — write:finance

Create a new tax rate.

### `finance.taxRates.delete` — delete:finance — destructive

Delete a tax rate. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.taxRates.list` — read:finance — read-only

List tax rates in the current workspace. Open to every workspace member (the permission key gates nobody); do not rely on it to restrict access.

### `finance.taxRates.update` — write:finance

Update an existing tax rate's fields.

### `finance.tickets.create` — write:finance

Create a new finance ticket.

### `finance.tickets.delete` — delete:finance — destructive

Delete a finance ticket. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `finance.tickets.get` — read:finance — read-only

Get a single finance ticket by ID.

### `finance.tickets.list` — read:finance — read-only

List finance tickets in the current workspace.

### `finance.tickets.update` — write:finance

Update an existing finance ticket's fields.

### `finance.vendors.create` — write:finance

Create a new vendor.

### `finance.vendors.delete` — delete:finance — destructive

Delete a vendor. Soft delete: the record is hidden from lists and lookups.

### `finance.vendors.get` — read:finance — read-only

Get a single vendor by ID.

### `finance.vendors.list` — read:finance — read-only

List vendors in the current workspace.

### `finance.vendors.update` — write:finance

Update an existing vendor's fields.

## Docs & wiki (8 tools: 4 read, 2 write, 2 delete)

### `docs.categories.create` — write:docs

Create a new docs category.

### `docs.categories.delete` — delete:docs — destructive

Delete a docs category. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `docs.categories.get` — read:docs — read-only

Get a single docs category by ID.

### `docs.categories.list` — read:docs — read-only

List docs categorys in the current workspace.

### `docs.categories.update` — write:docs

Update an existing docs category's fields.

### `docs.pages.delete` — delete:docs — destructive

Delete a docs page. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `docs.pages.get` — read:docs — read-only

Get a single docs page by ID.

### `docs.pages.list` — read:docs — read-only

List doc/wiki pages in the current workspace, with optional docType/status/isDeleted filter.

## Reports (1 tools: 1 read)

### `reports.list` — read:reports — read-only

List generated report snapshots in the current workspace.

## Goals & OKRs (18 tools: 8 read, 6 write, 4 delete)

### `goals.appreciations.create` — write:goals

Send an appreciation from the connected user to a workspace member.

### `goals.appreciations.delete` — delete:goals — destructive

Permanently delete one of the connected user's own appreciations. This cannot be undone.

### `goals.appreciations.get` — read:goals — read-only

Get a single appreciation by ID.

### `goals.appreciations.list` — read:goals — read-only

List appreciations visible to the connected user: all public ones plus private ones they sent or received.

### `goals.appreciations.update` — write:goals

Update one of the connected user's own appreciations.

### `goals.delete` — delete:goals — destructive

Delete a goal. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `goals.get` — read:goals — read-only

Get a single goal by ID.

### `goals.list` — read:goals — read-only

List goals in the current workspace.

### `goals.okrs.create` — write:goals

Create an OKR. Owner defaults to the connected user.

### `goals.okrs.delete` — delete:goals — destructive

Delete a OKR. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `goals.okrs.get` — read:goals — read-only

Get a single OKR by ID.

### `goals.okrs.list` — read:goals — read-only

List OKRs in the current workspace.

### `goals.okrs.update` — write:goals

Update an existing OKR's fields.

### `goals.oneOnOneMeetings.create` — write:goals

Schedule a one-on-one meeting hosted by the connected user.

### `goals.oneOnOneMeetings.delete` — delete:goals — destructive

Delete a one-on-one meeting. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `goals.oneOnOneMeetings.get` — read:goals — read-only

Get one of the connected user's own one-on-one meetings by ID.

### `goals.oneOnOneMeetings.list` — read:goals — read-only

List the connected user's own one-on-one meetings (as host or participant).

### `goals.oneOnOneMeetings.update` — write:goals

Update an existing one-on-one meeting's fields.

## Helpdesk (10 tools: 4 read, 4 write, 2 delete)

### `support.channels.delete` — delete:support — destructive

Delete a helpdesk channel (mailbox). Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `support.channels.get` — read:support — read-only

Get a single helpdesk channel (mailbox) by ID.

### `support.channels.list` — read:support — read-only

List helpdesk channel (mailbox)s in the current workspace.

### `support.channels.update` — write:support

Update an existing helpdesk channel (mailbox)'s fields.

### `support.tickets.assign` — write:support

Assign a support ticket to a workspace member (by their user ID). The assignee must belong to this workspace.

### `support.tickets.delete` — delete:support — destructive

Delete a ticket. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `support.tickets.get` — read:support — read-only

Get a single ticket by ID.

### `support.tickets.link_task` — write:support

Link a support ticket to a Work-module task. When autoResolveOnComplete is true (the default), the ticket auto-resolves once the linked task is marked done.

### `support.tickets.list` — read:support — read-only

List support tickets in the current workspace, with optional status/assignee filter.

### `support.tickets.unlink_task` — write:support

Remove a link between a support ticket and a Work-module task.

## AI agents (6 tools: 3 read, 2 write, 1 delete)

### `ai.agents.list` — read:ai — read-only

List AI agents configured in the current workspace.

### `ai.prompts.create` — write:ai

Create a new AI prompt.

### `ai.prompts.delete` — delete:ai — destructive

Deactivate an AI prompt (soft delete: sets active=false, the prompt row is kept).

### `ai.prompts.get` — read:ai — read-only

Get a single AI prompt by ID.

### `ai.prompts.list` — read:ai — read-only

List AI prompts in the current workspace.

### `ai.prompts.update` — write:ai

Update an AI prompt's content, module or active flag (bumps its version).

## Activity log (1 tools: 1 read)

### `activity.logs.list` — read:activity — read-only

List activity logs in the current workspace, with optional user/kind/date-range filter.

## Clients (3 tools: 2 read, 1 delete)

### `clients.orgs.delete` — delete:clients — destructive

Delete a client organization. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `clients.orgs.get` — read:clients — read-only

Get a single client organization by ID.

### `clients.orgs.list` — read:clients — read-only

List client organizations in the current workspace.

## Calendar (3 tools: 2 read, 1 delete)

### `calendar.events.delete` — delete:calendar — destructive

Delete a calendar event. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.

### `calendar.events.get` — read:calendar — read-only

Get a single calendar event by ID.

### `calendar.events.list` — read:calendar — read-only

List calendar events in the current workspace, with optional calendar filter.

## Integrations (1 tools: 1 read)

### `integrations.webhooks.list` — read:integrations — read-only

List webhooks in the current workspace.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.