Search Articles

  • REST Method: GET
  • URL: https://docsapi.helpscout.net/v1/search/articles

Use this endpoint to search for articles using a query. This endpoint returns an array of ArticleSearch objects. The ArticleSearch object contains attributes that are not present on an Article or ArticleRef object.

Request

Name Type Required Default Options Notes
page Int No 1    
query String Yes      
collectionId String No     Use this parameter to filter articles for a specific collection.
siteId String No     Use this parameter to filter articles for a specific site.
status String No all
  • all
  • published
  • notpublished
  
visibility String No all
  • all
  • public
  • private
 This parameter corresponds to the visibility of the collection that is associated with the article. Use this attribute to filter out articles in private collections.

To request subsequent pages:

  • https://docsapi.helpscout.net/v1/search/articles?page=2

Response

Response Name Type Notes
Header Status Int 200
Body page Int Current page that was passed in on the request
  pages Int Total number of pages available
  count Int Total number of objects available
  items Collection Collection of ArticleSearch objects. 
{
    "articles": {
        "page": 1,
        "pages": 1,
        "count": 4,
        "items": [
            {
                "id": "5215163545667acd25394b5c",
                "collectionId": "5214c77c45667acd25394b51",
                "categoryIds": [
                    "5214c77d45667acd25394b52"
                ],
                "slug": "my-article",
                "name": "My Article",
                "preview": "This is my article.",
                "url": "https://docs.helpscout.net/article/14-my-article",
                "docsUrl": "/docs/5214c77c45667acd25394b51/article/5215163545667acd25394b5c",
                "number": 14,
                "status": "published",
                "visibility": "public"
            },
            {... article search object ...},
            {... article search object ...},
            {... article search object ...}
        ]
    }
}
↑Back to top
© Help Scout 2024