Get knowledge articles

import requests
url = "https://example.ada.support/api/v2/knowledge/articles/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "5df263b7db5a7e6ea03fae9b",
      "name": "How to reset your password",
      "content": "# How to reset your password\\n\\n1. Go to the login page\\n2. Click on the \"Forgot password\" link\\n3. Follow the instructions",
      "url": "https://example.com/article",
      "knowledge_source_id": "5df263b7db5a7e6ea03fae9b",
      "language": "en",
      "tag_ids": [
        "5df263b7db5a7e6ea03fae9b",
        "5df263b7db5a7e6ea03fae9c"
      ],
      "created": "2020-09-20T00:00:00+00:00",
      "updated": "2020-09-20T00:00:00+00:00",
      "external_created": "2020-09-20T00:00:00+00:00",
      "external_updated": "2020-09-20T00:00:00+00:00",
      "enabled": true,
      "metadata": {
        "example_key1": "example_string_value",
        "example_key2": true,
        "example_key3": 123
      }
    }
  ],
  "meta": {
    "next_page_url": "https://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d"
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

cursorstringOptionalformat: "id"

The article cursor that marks the start or beginning of the returned article records

limitintegerOptional1-100

The number of article records to return

idlist of stringsOptional

Filter by article id

enabledlist of booleansOptional

Filter by enabled status

languagelist of stringsOptional

Filter by language

knowledge_source_idlist of stringsOptional

Filter by knowledge source

tag_idslist of stringsOptional

Filter by tag ids

Response

Matching knowledge articles

datalist of objects

metaobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error