Internal Article Search Response

Home/

REST API Reference

The results of an Internal Article search

typestring

The type of the object - list.

Value:"list"

Example:"list"

total_countinteger

The total number of Internal Articles matching the search query

Example:5

internal_articlesArray of objects(Internal Article)

An array of Internal Article objects

pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

{
  "type": "list",
  "total_count": 5,
  "internal_articles": [
    { … }
  ],
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "prev": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  }
}