Get Article

  • REST Method: GET
  • URL: https://docsapi.helpscout.net/v1/articles/{id}
  • URL: https://docsapi.helpscout.net/v1/articles/{number}

Note: Either the Article id or number can be passed to this endpoint.

Request

Name Type Required Default Notes
draft Boolean N false If the article has unpublished changes, setting this parameter to true will return the draft version of the article (if one exists). Otherwise the published version will be returned.

Response

Response Name Type Notes
Header Status Int 200
Body article Article 
{
    "article": {
        "id": "5215163545667acd25394b5c",
        "number": 121,
        "slug": "my-article",
        "status": "published",
        "hasDraft": false,
        "name": "My Article",
        "text": "Text of the article goes here.",
        "collectionId": "5214c77c45667acd25394b51",
        "categories": [
            "5214c77d45667acd25394b52"
        ],
        "related": [
            "521509f145667acd25394b5b",
            "521509f145667acd25394b5d"
        ],
        "publicUrl": "https://docs.helpscout.net/article/100-my-article",
        "popularity": 4.3,
        "viewCount": 236,
        "createdBy": 73423,
        "updatedBy": null,
        "createdAt": "2013-08-21T19:34:13Z",
        "updatedAt": null
    }
}
↑Back to top
© Help Scout 2024