Get knowledge articles

GET

Query parameters

cursorstringOptional

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

limitintegerOptional>=1<=100

The number of article records to return

idstringOptional

Filter by article id

enabledbooleanOptionalDefaults to false

Filter by enabled status

languagestringOptional

Filter by language

knowledge_source_idstringOptional

Filter by knowledge source

tag_idsstringOptional

Filter by tag ids

Response

Matching knowledge articles

datalist of objectsOptional

metaobjectOptional

GET

1 import requests
2 
3 url = "https://example.ada.support/api/v2/knowledge/articles/"
4 
5 querystring = {"cursor":"5df263b7db5a7e6ea03fae9b","limit":"10"}
6 
7 headers = {"Authorization": "Bearer <apiKey>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

200Retrieved

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       "locale": "en-CA",
10       "language": "en",
11       "tag_ids": [
12         "5df263b7db5a7e6ea03fae9b",
13         "5df263b7db5a7e6ea03fae9c"
14       ],
15       "created": "2020-09-20T00:00:00Z",
16       "updated": "2020-09-20T00:00:00Z",
17       "external_created": "2020-09-20T00:00:00Z",
18       "external_updated": "2020-09-20T00:00:00Z",
19       "enabled": true,
20       "metadata": {
21         "key": "value"
22       }
23     }
24   ],
25   "meta": {
26     "next_page_url": "http://example.ada.support/api/v2/end-users?cursor=6658f91ea88ff7e389eff34d"
27   }
28 }

Delete a single article

Up Next

Built with

1	import requests
2
3	url = "https://example.ada.support/api/v2/knowledge/articles/"
4
5	querystring = {"cursor":"5df263b7db5a7e6ea03fae9b","limit":"10"}
6
7	headers = {"Authorization": "Bearer <apiKey>"}
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	"locale": "en-CA",
10	"language": "en",
11	"tag_ids": [
12	"5df263b7db5a7e6ea03fae9b",
13	"5df263b7db5a7e6ea03fae9c"
14	],
15	"created": "2020-09-20T00:00:00Z",
16	"updated": "2020-09-20T00:00:00Z",
17	"external_created": "2020-09-20T00:00:00Z",
18	"external_updated": "2020-09-20T00:00:00Z",
19	"enabled": true,
20	"metadata": {
21	"key": "value"
22	}
23	}
24	],
25	"meta": {
26	"next_page_url": "http://example.ada.support/api/v2/end-users?cursor=6658f91ea88ff7e389eff34d"
27	}
28	}