Retrieve one knowledge base article

Overview

The get-one-article Ortto endpoint of the kb entity is used to retrieve one article within Ortto’s customer data platform (CDP).

NOTE: You can also retrieve more than one or all articles by referring to the v1/kb/get-articles endpoint in retrieve knowledge base articles.

This page provides descriptions of this endpoint’s:

Request resource and method.
Valid parameters, headers and request body values.
The response payload.

HTTP method and request resource


 POST https://api.ap3api.com/v1/kb/get-one-article

NOTE: Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:

Australia: https://api.au.ap3api.com/
Europe: https://api.eu.ap3api.com/

EX: https://api.eu.ap3api.com/v1/<entity/endpoint>

All other Ortto users will use the default service endpoint (https://api.ap3api.com/).

Path and query parameters

This endpoint takes no additional path and/or query parameters.

Headers

This endpoint requires a custom API key and content type (application/json for the request body) in the header of the request:

X-Api-Key: CUSTOM-PRIVATE-API-KEY
Content-Type: application/json

Request body

The request body consists of a JSON object whose valid elements are listed in the table below.

Example get one article request body from Ortto's CDP

json
 {
   "id": "650cf26b8bdeb4e9fbb12567"
}

Valid request body elements

The following table lists all valid, optional request body elements that are available at this endpoint.

Element	Type	Description
`id`	`string`	A string identifying the article ID by their unique ID number.

Response payload

The following JSON object is an example of an article call that Ortto retrieves from your Ortto account’s CDP after a request to this endpoint.

json
 {
   "id": "650cf26b8bdeb4e9fbb12567",
   "title": "Title",
   "description": "Testing",
   "html": "<full html>"
}

Response payload elements

The following table lists all elements (arrays, objects, or fields) in the response from a request to this endpoint.

Element	Type	Description
`id`	`string`	A string identifying the article ID by their unique ID number.
`title`	`string`	The title of the article.
`description`	`string`	The description included with the article.
`html`	`string`	The full HTML and it's containing elements (head, title, body etc.).

How to find article IDs

To find the article ID(s) for the kb element, follow these steps:

Navigate to Talk > Articles.
Click on the article you want to retrieve the ID for.
Copy the article ID from the URL.

NOTE: You can also retrieve article IDs by using the get-articles endpoint in retrieve knowledge base articles.