Help Scout

Manage mailboxes, conversations, and customers with the Help Scout API.

Detail	Value
Category	Support
Base URL	https://api.helpscout.net/v2
Authentication	OAuth2 Client Credentials
Endpoints	5
Connector key	help_scout

Using Help Scout in a workflow

1. Go to Connections and click New Connection.
2. Pick Help Scout from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

Endpoint	Summary
GET /conversations	List conversations
POST /conversations	Create a conversation
GET /conversations/{id}	Get a conversation
GET /mailboxes	List mailboxes
GET /customers	List customers

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /conversations

List conversations

Detail	Value
Operation ID	support.listConversations
Method	GET
Path	/conversations

Parameters

Name	Location	Type	Required
mailbox	query	string	No
status	query	string	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout connection from the Connection dropdown.
3. In the Operation dropdown, select support.listConversations.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout API reference.

POST /conversations

Create a conversation

Detail	Value
Operation ID	support.createConversation
Method	POST
Path	/conversations

Parameters

No parameters.

Request Body

Field	Type
subject	string
customer	object
mailboxId	integer
threads	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout connection from the Connection dropdown.
3. In the Operation dropdown, select support.createConversation.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout API reference.

GET /conversations/{id}

Get a conversation

Detail	Value
Operation ID	support.getConversation
Method	GET
Path	/conversations/{id}

Parameters

Name	Location	Type	Required
id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout connection from the Connection dropdown.
3. In the Operation dropdown, select support.getConversation.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout API reference.

GET /mailboxes

List mailboxes

Detail	Value
Operation ID	support.listMailboxes
Method	GET
Path	/mailboxes

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout connection from the Connection dropdown.
3. In the Operation dropdown, select support.listMailboxes.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout API reference.

GET /customers

List customers

Detail	Value
Operation ID	support.listCustomers
Method	GET
Path	/customers

Parameters

Name	Location	Type	Required
page	query	integer	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Help Scout connection from the Connection dropdown.
3. In the Operation dropdown, select support.listCustomers.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Help Scout API reference.