Tools

Your assistant picks these automatically; you rarely need to name one. The list is here so you know what the connection can and cannot reach. Every tool accepts an optional workspace argument. When your connection reaches more than one workspace, run ListWorkspaces first and name the workspace in your prompt. What a tool returns depends on the credential. Over OAuth, listings are filtered to the approving person’s permissions and a record they cannot open is refused; an API key reaches the whole workspace. A tool that needs the write or delete scope is also refused when the connection was not granted it. See Authentication.

Workspaces

Tool	What it does
`ListWorkspaces`	List the workspaces this connection can reach.

Clients

Clients are the billed entities that own projects and invoice recipients. See the API reference.

Tool	What it does
`ListClients`	List the organization’s clients. Used to resolve a name to an ID.
`GetClient`	Get a client’s details and its invoice recipients.
`CreateClient`	Create a client.
`UpdateClient`	Update a client. Only the provided fields change.

Recipients

Recipients receive a client’s invoices. See the API reference.

Tool	What it does
`CreateRecipient`	Add an invoice recipient to a client.
`UpdateRecipient`	Update a recipient. Only the provided fields change.
`DeleteRecipient`	Remove a recipient from a client.

Projects

See the API reference.

Tool	What it does
`ListProjects`	List projects, or find which projects a user is on.
`GetProject`	Get a project’s details, including its client, tasks, and project users.
`CreateProject`	Create a project under a client. A project must have at least one task.
`UpdateProject`	Update a project. Only the provided fields change.

Project users

See the API reference.

Tool	What it does
`ListProjectUsers`	List the active users on a project.
`AddProjectUser`	Add an organization user to a project so they can log time to it.
`UpdateProjectUser`	Update a project user’s role or hourly rate.
`RemoveProjectUser`	Remove a user from a project.

Time entries

See the API reference.

Tool	What it does
`ListTimeEntries`	List a project’s unbilled time entries, optionally for one user or one task.
`CreateTimeEntry`	Log a time entry for a user against a project’s task.
`UpdateTimeEntry`	Update an entry’s hours, date, or notes. Billed entries cannot be changed.
`DeleteTimeEntry`	Delete a time entry. Billed entries cannot be deleted.

Invoices

See the API reference.

Tool	What it does
`ListInvoices`	List the organization’s invoices, optionally filtered by client, status, or issue date range.
`CreateInvoice`	Generate an invoice for a client from unbilled time entries or services.
`SendInvoice`	Email an invoice to the client’s recipients. Every current recipient of the client receives it unless the call names some of them by recipient ID; an address that is not one of the client’s recipients cannot be given.

An invoice can be sent once the status that ListInvoices reports is generated, pending_payment, paid or written_off; one that is still generating is refused. Sending the same invoice again delivers it again.

Team members

See the API reference.

Tool	What it does
`ListTeamMembers`	List the organization’s active team members.
`GetTeamMember`	Get a team member’s details.
`CreateTeamMembers`	Invite one or more team members by email.
`UpdateTeamMember`	Update a team member’s profile or organization role.
`DeleteTeamMember`	Deactivate a team member, removing their access.

PTO

Tool	What it does
`ListMonthlyPto`	Read the monthly PTO report: per user, PTO earned, used, and net balance.
`UpdatePtoEarned`	Set PTO earned in hours for one or more users for a month.

Reports

Tool	What it does
`PayrollSummary`	Per user, working days and loss-of-pay days for a month.
`TimesheetSummary`	Per user, per day, per project hours for a date range.
`ListMissingTimesheetEntries`	A user’s working days in a range with no timesheet entry.

PTO and report tools have no REST API reference pages yet. They are also available from the command line: see monthly-ptos and reports.

Getting Started

Reference

Workspaces

Clients

Recipients

Projects

Project users

Time entries

Invoices

Team members

PTO

Reports

​Workspaces

​Clients

​Recipients

​Projects

​Project users

​Time entries

​Invoices

​Team members

​PTO

​Reports

Workspaces

Clients

Recipients

Projects

Project users

Time entries

Invoices

Team members

PTO

Reports