Get Docs article
One Docs article with its text, status, collection and draft.
GET https://cotlet.dev/api/v1/help-scout/articles/{article_id}/docs-article
read
Returns the article as published and, with draft set to true, the draft text, which is not live yet, if one exists. The text is HTML, as the Docs editor stores it. Check has_draft first: a draft by a teammate should not be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
| article_id string required | string | Article ID from search_docs_articles. |
| draft boolean | boolean | Return the draft text instead of the published text. Default: false. |
Request
curl https://cotlet.dev/api/v1/help-scout/articles/article_8c41d2/docs-article \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("help-scout", "get_docs_article", {"article_id":"article_8c41d2"})const result = await cotlet.call('help-scout', 'get_docs_article', {"article_id":"article_8c41d2"});cotlet call help-scout get_docs_article --data '{"article_id":"article_8c41d2"}'Example response
{
"article_id": "6628f1a2b5d30",
"name": "Export conversation data",
"collection": "Using Help Scout",
"status": "published",
"has_draft": false,
"text": "<p>Open <strong>Reports</strong> from the top menu, choose a date range and click <strong>Export</strong>.</p>"
}