Knowledge Base

Retrieve all articles associated with a property using cursor-based pagination. The results are sorted by creation date in descending order, with a page size of 25 items.

get/kb/articles

Request

  • Base URL: https://api.charla.com/v1
  • URL: https://api.charla.com/v1/kb/articles
  • Auth: API key in header X-Api-Key

Query parameters

cursorstring

An opaque pagination cursor (Optional).
Omit this parameter to start from the beginning.
Pass the next_cursor value from the previous response to fetch the next page.

Response

OK

Example response

{
  "data": [
    {
      "categories": [
        {
          "id": 1,
          "name": "Using Chatrla"
        }
      ],
      "status": "Published",
      "visibility": "Private"
    }
  ],
  "paging": {
    "total": 25,
    "next_cursor": "NjM4OTMzNjA5NDgxMjMwMDAwXzQzNTI1",
    "has_next": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.