Help Scout API

14 endpoints for Help Scout, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/help-scout
Connects with: Your own Help Scout user account (Account Owner, Administrator or User; Light Users cannot assign conversations). The agent acts as you and sees only the inboxes you can open.
Integration page: Help Scout

Read (7)

Return data and change nothing in the account.

Help Scout Endpoints: Read
Endpoint	Description
GET /conversations/search	Conversations matching a Help Scout search: status, tag, assignee, subject and free text.
GET /conversations/{conversation_id}	One conversation with its customer, status, assignee, tags and every thread, notes included.
GET /inboxes	Inboxes your account can open, with their folders.
GET /saved-replies	Saved replies of an inbox, with their names and text.
GET /tags	Tags in use, with how many conversations carry each.
GET /docs-articles/search	Docs articles matching a search, across your Docs sites.
GET /articles/{article_id}/docs-article	One Docs article with its text, status, collection and draft.

Change the account. Calls marked Confirm wait for the user to approve them.

Help Scout Endpoints: Write
Endpoint	Description
POST /conversations/{conversation_id}/replies Confirm	Reply to the customer of a conversation and set its status.
POST /conversations/{conversation_id}/notes	Add an internal note to a conversation.
POST /conversations/{conversation_id}/tag	Add or remove tags on one conversation.
POST /conversations/{conversation_id}/assign	Assign a conversation to a teammate, a team or nobody.
PUT /conversations/{conversation_id}/status	Change a conversation to active, pending or closed.
POST /articles/{article_id}/docs-article-draft/save	Save new text as the draft of a Docs article without changing the live article.
POST /articles/{article_id}/docs-article/publish Confirm	Publish the draft of a Docs article, or unpublish the article.