My order has not arrived.
", "cc": [], "created_at": "2026-09-01T10:00:00Z", "created_by": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "customer": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "id": 9001, "opened_at": null, "saved_reply_id": null, "source": { "type": "email", "via": "customer" }, "state": "published", "status": "active", "to": [], "type": "customer" } ], "type": "email", "user_updated_at": "2026-09-01T10:05:00Z", "web_url": "https://secure.helpscout.net/conversation/123456789/42/" } ``` ### Get current user Read the Help Scout user this connection acts as - the person who created the app. **Inputs**: None. **Outputs** - `company_id` (number) - `created_at` (text) - `email` (text) - `first_name` (text) - `id` (number) - `job_title` (text) - `last_name` (text) - `phone` (text) - `role` (text) - `timezone` (text) - `type` (text) - `updated_at` (text) **Example output** ```json { "company_id": 1001, "created_at": "2026-01-01T09:00:00Z", "email": "sam@example.com", "first_name": "Sam", "id": 301, "job_title": null, "last_name": "Agent", "phone": null, "role": "owner", "timezone": "Europe/London", "type": "user", "updated_at": "2026-09-01T09:00:00Z" } ``` ### Get customer Read a customer's profile: name, emails, phones, websites, job title, location, notes and how many conversations they have. **Inputs** - Customer ID (`customer_id`, text, required): The customer's id - the 'id' of a List customers result, or the number in the address bar of their Help Scout profile. **Outputs** - `age` (text) - `background` (text) - `conversation_count` (number) - `created_at` (text) - `email` (text) - `emails` (list) - `first_name` (text) - `gender` (text) - `id` (number) - `job_title` (text) - `last_name` (text) - `location` (text) - `organization_id` (number) - `phones` (list) - `photo_url` (text) - `updated_at` (text) - `websites` (list) **Example output** ```json { "age": "36", "background": "Prefers email.", "conversation_count": 1, "created_at": "2026-08-01T09:00:00Z", "email": "ada@example.com", "emails": [ { "id": 1, "type": "work", "value": "ada@example.com" } ], "first_name": "Ada", "gender": "female", "id": 501, "job_title": "Engineer", "last_name": "Lovelace", "location": "London", "organization_id": null, "phones": [], "photo_url": null, "updated_at": "2026-09-01T09:00:00Z", "websites": [] } ``` ### List conversation messages List the messages, replies, notes and activity (threads) in a conversation, with their text, author and time. **Inputs** - Conversation ID (`conversation_id`, text, required): The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number. - Page (`page`, number): Which page of results to return, starting at 1. From 1 to 100000. Default: `1`. **Outputs** - `count` (number) - `has_more` (true/false) - `items` (list): The conversation's threads - `page` (number) - `total` (number) - `total_pages` (number) **Example output** ```json { "count": 1, "has_more": false, "items": [ { "action_text": null, "assigned_to": null, "attachments": [], "bcc": [], "body": "My order has not arrived.
", "cc": [], "created_at": "2026-09-01T10:00:00Z", "created_by": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "customer": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "id": 9001, "opened_at": null, "saved_reply_id": null, "source": { "type": "email", "via": "customer" }, "state": "published", "status": "active", "to": [], "type": "customer" } ], "page": 1, "total": 1, "total_pages": 1 } ``` ### List conversations Find conversations, filtered by inbox, folder, status, tags, assignee, number or last-modified date, or with Help Scout's search syntax. Returns one page of conversations with their subject, status, customer, assignee and tags. **Inputs** - Inbox (`inbox_id`, text): Only this inbox. Leave empty for every inbox you can access. - Folder (`folder_id`, text): Only this folder of the chosen inbox. - Status (`status`, text): Which conversations to include. Defaults to Active. One of: `active`, `pending`, `closed`, `open`, `spam`, `all`. - Tags (`tags`, text): Only conversations carrying these tags. - Assigned to (`assigned_to`, text): Only conversations assigned to this teammate. - Modified since (`modified_since`, date and time): Only conversations changed on or after this time. - Conversation number (`number`, number): Only the conversation with this #number. - Search (`query`, text): Help Scout search syntax, such as (subject:"refund") or (email:"ada@example.com"). - Sort by (`sort_field`, text): Defaults to Created. One of: `modifiedAt` (Last modified), `createdAt` (Created), `waitingSince` (Waiting since), `number` (Conversation number), `subject`, `status`, `customerName` (Customer name), `customerEmail` (Customer email), `mailboxid` (Inbox), `score` (Search relevance). - Sort order (`sort_order`, text): Defaults to newest first. One of: `desc` (Newest / highest first), `asc` (Oldest / lowest first). - Page (`page`, number): Which page of results to return, starting at 1. From 1 to 100000. Default: `1`. **Outputs** - `count` (number) - `has_more` (true/false) - `items` (list): The matching conversations - `page` (number) - `total` (number) - `total_pages` (number) **Example output** ```json { "count": 1, "has_more": false, "items": [ { "assignee": { "email": "sam@example.com", "first_name": "Sam", "id": 301, "last_name": "Agent", "type": "user" }, "bcc": [], "cc": [], "closed_at": null, "closed_by": null, "created_at": "2026-09-01T10:00:00Z", "created_by": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "custom_fields": [], "customer_waiting_since": "2026-09-01T10:00:00Z", "folder_id": 201, "id": 123456789, "inbox_id": 101, "number": 42, "preview": "My order has not arrived.", "primary_customer": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "source": { "type": "email", "via": "customer" }, "state": "published", "status": "active", "subject": "Where is my order?", "tags": [ "shipping" ], "thread_count": 1, "type": "email", "user_updated_at": "2026-09-01T10:05:00Z", "web_url": "https://secure.helpscout.net/conversation/123456789/42/" } ], "page": 1, "total": 1, "total_pages": 1 } ``` ### List customers Find customers by email, name, or Help Scout's search syntax, or those created or changed since a date. Newest first. Pass the result's next cursor to get the following page. **Inputs** - Email (`email`, text): Only the customer with this email address. - First name (`first_name`, text): Up to 40 characters. - Last name (`last_name`, text): Up to 40 characters. - Search (`query`, text): Help Scout search syntax, such as (firstName:"Ada"). - Created since (`created_since`, date and time): Only customers created on or after this time. - Modified since (`modified_since`, date and time): Only customers changed on or after this time. - Next page cursor (`cursor`, text): The next_cursor of an earlier List customers result, with the same filters. Leave empty for the first page. **Outputs** - `count` (number) - `has_more` (true/false) - `items` (list): The matching customers - `next_cursor` (text) **Example output** ```json { "count": 1, "has_more": false, "items": [ { "age": "36", "background": "Prefers email.", "conversation_count": 1, "created_at": "2026-08-01T09:00:00Z", "email": "ada@example.com", "emails": [ { "id": 1, "type": "work", "value": "ada@example.com" } ], "first_name": "Ada", "gender": "female", "id": 501, "job_title": "Engineer", "last_name": "Lovelace", "location": "London", "organization_id": null, "phones": [], "photo_url": null, "updated_at": "2026-09-01T09:00:00Z", "websites": [] } ], "next_cursor": null } ``` ### List inbox folders List an inbox's folders (Unassigned, Mine, Closed and so on) with how many conversations each holds. **Inputs** - Inbox (`inbox_id`, text, required): The Help Scout inbox (called a mailbox in older Help Scout pages). - Page (`page`, number): Which page of results to return, starting at 1. From 1 to 100000. Default: `1`. **Outputs** - `count` (number) - `has_more` (true/false) - `items` (list): The inbox's folders - `page` (number) - `total` (number) - `total_pages` (number) **Example output** ```json { "count": 1, "has_more": false, "items": [ { "active_count": 2, "id": 201, "name": "Unassigned", "total_count": 3, "type": "open", "updated_at": "2026-09-01T09:00:00Z", "user_id": 0 } ], "page": 1, "total": 1, "total_pages": 1 } ``` ### List inboxes List the inboxes you can access, with their ids and addresses. **Inputs** - Page (`page`, number): Which page of results to return, starting at 1. From 1 to 100000. Default: `1`. **Outputs** - `count` (number) - `has_more` (true/false) - `items` (list): The inboxes - `page` (number) - `total` (number) - `total_pages` (number) **Example output** ```json { "count": 1, "has_more": false, "items": [ { "created_at": "2026-01-01T09:00:00Z", "email": "support@example.com", "id": 101, "name": "Support", "slug": "a1b2c3d4e5f60718", "updated_at": "2026-09-01T09:00:00Z" } ], "page": 1, "total": 1, "total_pages": 1 } ``` ### List saved replies List an inbox's saved replies, with a preview of each. **Inputs** - Inbox (`inbox_id`, text, required): The Help Scout inbox (called a mailbox in older Help Scout pages). - Include chat replies (`include_chat_replies`, true/false): Also include saved replies made for chat. **Outputs** - `count` (number) - `items` (list): The saved replies **Example output** ```json { "count": 1, "items": [ { "chat_preview": null, "id": 601, "name": "Refund policy", "preview": "Refunds are issued within 5 days..." } ] } ``` ### List tags List the account's tags and how many conversations use each. **Inputs** - Page (`page`, number): Which page of results to return, starting at 1. From 1 to 100000. Default: `1`. **Outputs** - `count` (number) - `has_more` (true/false) - `items` (list): The tags - `page` (number) - `total` (number) - `total_pages` (number) **Example output** ```json { "count": 1, "has_more": false, "items": [ { "conversation_count": 12, "created_at": "2026-01-01T09:00:00Z", "id": 401, "name": "shipping", "slug": "shipping", "updated_at": "2026-09-01T09:00:00Z" } ], "page": 1, "total": 1, "total_pages": 1 } ``` ### List users List your Help Scout teammates, optionally only those with access to one inbox or with one email address. **Inputs** - Email (`email`, text): Only the teammate with exactly this email. - Inbox (`inbox_id`, text): Only this inbox. Leave empty for every inbox you can access. - Page (`page`, number): Which page of results to return, starting at 1. From 1 to 100000. Default: `1`. **Outputs** - `count` (number) - `has_more` (true/false) - `items` (list): The teammates - `page` (number) - `total` (number) - `total_pages` (number) **Example output** ```json { "count": 1, "has_more": false, "items": [ { "created_at": "2026-01-01T09:00:00Z", "email": "sam@example.com", "first_name": "Sam", "id": 301, "job_title": null, "last_name": "Agent", "phone": null, "role": "owner", "timezone": "Europe/London", "type": "user", "updated_at": "2026-09-01T09:00:00Z" } ], "page": 1, "total": 1, "total_pages": 1 } ``` ### Reply to conversation Reply to the customer on a conversation. The reply is emailed to the customer unless it is saved as a draft. Replies to the conversation's primary customer unless you name another. **Inputs** - Conversation ID (`conversation_id`, text, required): The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number. - Reply (`text`, text, required): The reply text. Basic HTML is allowed. - Save as draft (`draft`, true/false): Save the reply as a draft instead of sending it. - Status (`status`, text): The conversation status to set. Leave empty to keep it as it is. One of: `active`, `pending`, `closed`. - Assign to (`assign_to`, text): The teammate to assign the conversation to. - CC (`cc`, list): Email addresses to copy on the reply. - BCC (`bcc`, list): Email addresses to blind-copy on the reply. - Customer ID (`customer_id`, text): The customer to reply to. Leave empty for the conversation's primary customer. **Outputs** - `conversation_id` (number) - `customer_id` (number) - `draft` (true/false) - `id` (number) **Example output** ```json { "conversation_id": 123456789, "customer_id": 501, "draft": false, "id": 9002 } ``` ### Tag conversation Add tags to a conversation, remove some, replace them all, or clear them. A tag that does not exist yet is created. Returns the conversation's tags afterwards. **Inputs** - Conversation ID (`conversation_id`, text, required): The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number. - Tags (`tags`, text): Tag names. A tag that does not exist yet is created by Help Scout. - What to do (`mode`, text): Defaults to adding the tags. One of: `add` (Add these tags, keep the rest), `remove` (Remove these tags, keep the rest), `replace` (Replace all tags with these), `clear` (Remove every tag). **Outputs** - `conversation_id` (number) - `mode` (text) - `tags` (list) **Example output** ```json { "conversation_id": 123456789, "mode": "add", "tags": [ "shipping", "vip" ] } ``` ### Update conversation Change a conversation's subject, status, inbox, primary customer or assignee, or unassign it. Only the fields you set are changed. Returns the updated conversation. **Inputs** - Conversation ID (`conversation_id`, text, required): The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number. - Subject (`subject`, text): A new subject line. - Status (`status`, text): The conversation status to set. Leave empty to keep it as it is. One of: `active`, `pending`, `closed`. - Move to inbox (`move_to_inbox_id`, text): Move the conversation to this inbox. - Assign to (`assign_to`, text): The teammate to assign the conversation to. - Unassign (`unassign`, true/false): Remove the current assignee. - Primary customer ID (`customer_id`, text): Make this customer the conversation's primary customer. **Outputs** - `assignee` (object) - `bcc` (list) - `cc` (list) - `changed` (list) - `closed_at` (text) - `closed_by` (object) - `created_at` (text) - `created_by` (object) - `custom_fields` (list) - `customer_waiting_since` (text) - `folder_id` (number) - `id` (number) - `inbox_id` (number) - `number` (number) - `preview` (text) - `primary_customer` (object) - `source` (object) - `state` (text) - `status` (text) - `subject` (text) - `tags` (list) - `thread_count` (number) - `type` (text) - `user_updated_at` (text) - `web_url` (text) **Example output** ```json { "assignee": { "email": "sam@example.com", "first_name": "Sam", "id": 301, "last_name": "Agent", "type": "user" }, "bcc": [], "cc": [], "changed": [ "status" ], "closed_at": null, "closed_by": null, "created_at": "2026-09-01T10:00:00Z", "created_by": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "custom_fields": [], "customer_waiting_since": "2026-09-01T10:00:00Z", "folder_id": 201, "id": 123456789, "inbox_id": 101, "number": 42, "preview": "My order has not arrived.", "primary_customer": { "email": "ada@example.com", "first_name": "Ada", "id": 501, "last_name": "Lovelace", "type": "customer" }, "source": { "type": "email", "via": "customer" }, "state": "published", "status": "active", "subject": "Where is my order?", "tags": [ "shipping" ], "thread_count": 1, "type": "email", "user_updated_at": "2026-09-01T10:05:00Z", "web_url": "https://secure.helpscout.net/conversation/123456789/42/" } ``` ### Update customer Change a customer's name, job title, location, notes, age or gender, and add an email address or phone number. Only the fields you set are changed. **Inputs** - Customer ID (`customer_id`, text, required): The customer's id - the 'id' of a List customers result, or the number in the address bar of their Help Scout profile. - First name (`first_name`, text): Up to 40 characters. - Last name (`last_name`, text): Up to 40 characters. - Job title (`job_title`, text): Up to 60 characters. - Location (`location`, text): Up to 60 characters. - Notes (`background`, text): The Notes field on the customer's profile. Up to 200 characters. - Age (`age`, text): Free text, such as 34 or 30-35. - Gender (`gender`, text): Leave empty to keep it as it is. One of: `male`, `female`, `unknown`. - Add email (`add_email`, text): Add this email address as a work email. - Add phone (`add_phone`, text): Add this phone number as a work phone. **Outputs** - `age` (text) - `background` (text) - `changed` (list) - `conversation_count` (number) - `created_at` (text) - `email` (text) - `emails` (list) - `first_name` (text) - `gender` (text) - `id` (number) - `job_title` (text) - `last_name` (text) - `location` (text) - `organization_id` (number) - `phones` (list) - `photo_url` (text) - `updated_at` (text) - `websites` (list) **Example output** ```json { "age": "36", "background": "Prefers email.", "changed": [ "jobTitle" ], "conversation_count": 1, "created_at": "2026-08-01T09:00:00Z", "email": "ada@example.com", "emails": [ { "id": 1, "type": "work", "value": "ada@example.com" } ], "first_name": "Ada", "gender": "female", "id": 501, "job_title": "Engineer", "last_name": "Lovelace", "location": "London", "organization_id": null, "phones": [], "photo_url": null, "updated_at": "2026-09-01T09:00:00Z", "websites": [] } ```