Help Scout Docs

Help Scout Docs integration (Productivity, Communication). Imported from open-connector.

API key6 toolshttps://docsapi.helpscout.net/v1

GET

helpscout_docs_list_sites

List Help Scout Docs sites available to the API key.

/sites

2 parameters

Param	Type	Required	Description
page	integer	optional	The 1-based page number to request.
pageSize	integer	optional	The number of items Help Scout Docs should return per page.

GET

helpscout_docs_list_collections

List Help Scout Docs collections available to the API key.

/collections

2 parameters

Param	Type	Required	Description
page	integer	optional	The 1-based page number to request.
pageSize	integer	optional	The number of items Help Scout Docs should return per page.

GET

helpscout_docs_list_categories

List Help Scout Docs categories in a collection.

/collections/{collectionId}/categories

3 parameters

Param	Type	Required	Description
collectionId	string	required	The Help Scout Docs collection ID whose categories to list.
page	integer	optional	The 1-based page number to request.
pageSize	integer	optional	The number of items Help Scout Docs should return per page.

GET

helpscout_docs_list_articles

List Help Scout Docs articles in a collection or category.

/collections/{collectionId}/articles

4 parameters

Param	Type	Required	Description
collectionId	string	required	The Help Scout Docs collection ID whose articles to list.
categoryId	string	optional	The Help Scout Docs category ID whose articles to list.
page	integer	optional	The 1-based page number to request.
pageSize	integer	optional	The number of items Help Scout Docs should return per page.

GET

helpscout_docs_search_articles

Search Help Scout Docs articles by query with optional collection and site filters.

/search/articles

6 parameters

Param	Type	Required	Description
query	string	required	The search query to run against Help Scout Docs articles.
collectionId	string	optional	The optional Help Scout Docs collection ID to filter by.
siteId	string	optional	The optional Help Scout Docs site ID to filter by.
visibility	string	optional	The optional collection visibility filter.
page	integer	optional	The 1-based page number to request.
pageSize	integer	optional	The number of items Help Scout Docs should return per page.

GET

helpscout_docs_get_article

Get a Help Scout Docs article by ID or article number.

/articles/{articleIdOrNumber}

2 parameters

Param	Type	Required	Description
articleIdOrNumber	string	required	The Help Scout Docs article ID or article number to fetch.
draft	boolean	optional	Whether to return the draft version when unpublished changes exist.