Get knowledge articles

1 import requests 2 3 url = "https://example.ada.support/api/v2/knowledge/articles/" 4 5 querystring = {"cursor":"5df263b7db5a7e6ea03fae9b","limit":"10","id":"[\"foo\"]","enabled":"[true]","language":"[\"foo\"]","knowledge_source_id":"[\"foo\"]","tag_ids":"[\"foo\"]"} 6 7 headers = {"Authorization": "Bearer <token>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "data": [ 3 { 4 "id": "5df263b7db5a7e6ea03fae9b", 5 "name": "How to reset your password", 6 "content": "# How to reset your password\\n\\n1. Go to the login page\\n2. Click on the \"Forgot password\" link\\n3. Follow the instructions", 7 "url": "https://example.com/article", 8 "knowledge_source_id": "5df263b7db5a7e6ea03fae9b", 9 "language": "ar", 10 "tag_ids": [ 11 "foo" 12 ], 13 "created": "2020-09-20T00:00:00+00:00", 14 "updated": "2020-09-20T00:00:00+00:00", 15 "external_created": "2020-09-20T00:00:00+00:00", 16 "external_updated": "2020-09-20T00:00:00+00:00", 17 "enabled": true, 18 "metadata": {} 19 } 20 ], 21 "meta": { 22 "next_page_url": "http://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d" 23 } 24 }

Headers

AuthorizationstringRequired

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

limitintegerOptional>=1<=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 objectsOptional

metaobjectOptional