Get a single knowledge article

Get knowledge article by id

Path parameters

idstringRequired

The id of the article to retrieve

Headers

AuthorizationstringRequired

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

Response

Knowledge article

idstring>=1 character<=160 characters

A unique identifier for the article

namestring>=1 character<=255 characters

The name or title of the article

contentstring>=1 character

The content of the article in markdown format

urlstringOptionalformat: "url"

The url of the article

knowledge_source_idstringOptional

The id of the knowledge_source the article belongs to

languageenumOptional

The ISO 639-1 language code of the article, defaults to en

tag_idslist of stringsOptional

A list of ids for the tags associated with the article

createdstringOptionalformat: "date-time"

The date the article was created in Ada

updatedstringOptionalformat: "date-time"

The date the article was last updated in Ada

external_createdstringOptionalformat: "date-time"

The date the article was created in the source system

external_updatedstringOptionalformat: "date-time"

The date the article was last updated in the source system

enabledbooleanOptional

Whether the article should be referenced during response generation, defaults to true

metadataobjectOptional

A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the article.

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

1	{
2	"id": "5df263b7db5a7e6ea03fae9b",
3	"name": "How to reset your password",
4	"content": "# How to reset your password\\n\\n1. Go to the login page\\n2. Click on the \"Forgot password\" link\\n3. Follow the instructions",
5	"url": "https://example.com/article",
6	"knowledge_source_id": "5df263b7db5a7e6ea03fae9b",
7	"language": "ar",
8	"tag_ids": [
9	"foo"
10	],
11	"created": "2020-09-20T00:00:00+00:00",
12	"updated": "2020-09-20T00:00:00+00:00",
13	"external_created": "2020-09-20T00:00:00+00:00",
14	"external_updated": "2020-09-20T00:00:00+00:00",
15	"enabled": true,
16	"metadata": {}
17	}