Show Developer Menu

GET /articles

Issuing a GET call to articles will allow you to retrieve KB articles for the Brand

Alternative: GET /topics/{slug}/articles

Alternatively, you can issue a GET to articles within a specific topic slug to get articles scoped to that topic.

Example Request
curl 'https://{brand}.reamaze.com/api/v1/articles' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
{
  "page_size": 30,
  "page_count": 1,
  "total_count": 10,
  "articles": [
    {
      "title": "Advantage of the Union in Respect to Economy in Government",
      "body": "...",
      "slug": "advantage-of-the-union",
      "status": 0,
      "created_at": "2014-05-06T10:17:28.000-07:00",
      "updated_at": "2014-05-06T10:17:28.000-07:00",
      "url": "...",
      "author": {
        "name": "Alexander Hamilton",
        "email": "alexander.hamilton@reamaze.com"
      },
      "topic": {
        "name": "The Federalist Papers",
        "slug": "the-federalist-papers"
      }
    }
    ...
  ]
}
Optional Params

By default, this API end point only returns published articles.

  • status with published, draft, or internal will show only Published, Draft, or Internal articles respectively.
  • q with any string will search over articles by keywords.
  • page with any number will allow you to paginate through results. page_size and page_count are provided by the result.
Notes
  • The status value denotes the visibility of the article: 0 (Published), 1 (Draft), 4 (Internal)