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

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"`)