tools/list at connection time. All tools are workspace-scoped — you only access data in your own workspace.
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 for scope details.CRM (50 tools: 20 read, 20 write, 10 delete)
crm.companies.create — write:crm
Create a company.
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.companies.update — write:crm
Update a company’s name, industry, website, phone or status.
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.create — write:crm
Create a deal.
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.deals.update — write:crm
Update a deal’s stage, status, value, assignee or other fields. Pass expectedVersion to fail on a concurrent edit.
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 (37 tools: 16 read, 15 write, 6 delete)
approvals.decide — write:work
Approve or reject the current pending step of an approval request. Fails if the caller is not the assigned approver for the current step.
approvals.list — read:work — read-only
List approval requests in the current workspace. Owner/admin see all; others see only where they are the requester or current-step approver.
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.create — write:work
Create a new milestone on a project in the current workspace.
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.project_members.assign — write:work
Assign a workspace member to a project with a given role.
work.projects.create — write:work
Create a new project 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.projects.update — write:work
Update a project’s fields.
work.sprints.create — write:work
Create a new sprint in the current workspace.
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.sprints.update — write:work
Update a sprint’s fields.
work.task_comments.create — write:work
Add a comment to a task in the current workspace.
work.task_comments.list — read:work — read-only
List comments on a task in the current workspace. Returns comments sorted by newest first.
work.tasks.create — write:work
Create a new task in the current workspace.
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.
work.tasks.update — write:work
Update a task’s status, assignee, dates or other fields.
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 (15 tools: 6 read, 6 write, 3 delete)
marketing.campaigns.create — write:marketing
Create a marketing campaign (draft by default).
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.campaigns.update — write:marketing
Update a marketing campaign’s fields.
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 (38 tools: 20 read, 12 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.employees.update — write:hrms
Update an employee record’s profile fields (not the linked login).
hrms.leaveRequests.create — write:hrms
File a leave request for the connected user’s own employee record. It is always created as pending.
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 (25 tools: 10 read, 10 write, 5 delete)
lms.categories.create — write:lms
Create a new course category.
lms.categories.delete — delete:lms — destructive
Delete a course category. Depending on the record type this hides it (soft delete) or removes it permanently, so treat it as irreversible.
lms.categories.get — read:lms — read-only
Get a single course category by ID.
lms.categories.list — read:lms — read-only
List course categories in the current workspace.
lms.categories.update — write:lms
Update an existing course category’s fields.
lms.courses.create — write:lms
Create a course.
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.courses.update — write:lms
Update a course’s fields.
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 (20 tools: 8 read, 8 write, 4 delete)
recruitment.applicants.create — write:recruitment
Add an applicant, optionally against a job posting.
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.create — write:recruitment
Create a job posting.
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.jobPostings.update — write:recruitment
Update a job posting’s fields.
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 (59 tools: 23 read, 24 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.create — write:finance
Create a draft estimate (quote). Send lineItems as [{ name, quantity, unitPrice, discountPct?, taxPct? }]: discountPct is clamped to 0-100 and taxPct to 0 or more. subtotal, discount, tax and total are always computed on the server from the lines (any totals you send are ignored), so total = subtotal - discount + tax. clientId is a CRM company id, contactId a CRM contact and dealId a CRM deal; each must belong to your workspace. A productId is kept only when it is one of your workspace’s CRM products, otherwise the line is saved as a manual line. issueDate and validUntil are YYYY-MM-DD. The quote number (Q-<year>-<seq>) is assigned automatically and the status is always draft.