Manage helpdesk tickets, customers, and inboxes in Teamwork Desk via the v2 REST API.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Teamwork Desk

Manage helpdesk tickets, customers, and inboxes in Teamwork Desk via the v2 REST API.

Operations

Operation	Description
`list_tickets`	Retrieve a paginated list of all tickets
`get_ticket`	Retrieve a single ticket by ID
`create_ticket`	Create a new support ticket in an inbox
`list_customers`	Retrieve a paginated list of customers
`list_inboxes`	Retrieve a paginated list of inboxes

API Key Setup

Log in to your Teamwork account.
Click your avatar (top-right) → Settings.
Navigate to API and click Generate API key (or copy an existing one).
Use that key as the apiKey input.

Your site name is the subdomain in your Teamwork URL: https://{siteName}.teamwork.com.

Authentication

Teamwork Desk v2 uses HTTP Bearer authentication:

Authorization: Bearer {apiKey}

Base URL: https://{siteName}.teamwork.com/desk/api/v2

Inputs

Input	Required	Description
`apiKey`	Yes	Teamwork API key
`operation`	Yes	One of the operations listed above
`siteName`	Yes	Your Teamwork site name
`ticketId`	For `get_ticket`	Integer ID of the ticket
`subject`	For `create_ticket`	Ticket subject line
`body`	For `create_ticket`	Body text of the first message
`inboxId`	For `create_ticket`	Integer ID of the inbox to file the ticket in
`customerEmail`	Optional	Customer email for `create_ticket`
`customerName`	Optional	Customer full name for `create_ticket`

Examples

List all tickets:

apiKey: abc123...
siteName: mycompany
operation: list_tickets

Get a specific ticket:

apiKey: abc123...
siteName: mycompany
operation: get_ticket
ticketId: 12345

Create a ticket:

apiKey: abc123...
siteName: mycompany
operation: create_ticket
inboxId: 1
subject: Cannot log in
body: I am unable to log in to the portal since yesterday.
customerEmail: [email protected]
customerName: Jane Doe

List customers:

apiKey: abc123...
siteName: mycompany
operation: list_customers

List inboxes:

apiKey: abc123...
siteName: mycompany
operation: list_inboxes

Outputs

Output	Description
`result`	Raw JSON response body from the Teamwork Desk API
`status`	HTTP status code as a string (e.g. `"200"`)

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: list_tickets, get_ticket, create_ticket, list_customers, list_inboxes
`siteName`	string	no	—	Your Teamwork site name (the {siteName} in https://{siteName}.teamwork.com). Required.
`ticketId`	string	no	—	Ticket id (integer) for get_ticket.
`subject`	string	no	—	Subject line for create_ticket.
`inboxId`	string	no	—	Inbox id (integer) the ticket belongs to for create_ticket. Required for create_ticket.
`customerEmail`	string	no	—	Customer email address for create_ticket.
`customerName`	string	no	—	Customer full name for create_ticket (used if creating a new customer).