Knowledge Base Endpoints

Knowledge Base

KBEntry

GET /KBArticle

Summary: List of KBEntry

Returns multiple KBEntry objects. Requires authentication.

Query Parameters:

Name	Type	Description
activeinactive	string	Filter on active/inactive assets — comma separated, first value true or false for active, second for inactive.
advanced_search	string	Advanced search string.
articletype	string	Filter on article type, comma separated.
client_id	integer	Filters by the specified client.
count	integer	Number of Knowledge Base Entries to return in the response.
device_id	integer	Filter by device ID.
faqlists	string	Filters response based on the Knowledge Base Article FAQ lists.
includeactive	boolean	Include active Knowledge Base Entries in the response.
includeinactive	boolean	Include inactive Knowledge Base Entries in the response.
key	string	Filters response based on the knowledge base key.
language_code	string	Language code filter.
language_override	string	Language override value.
needsreview	string	Filter on Knowledge Base Articles that are past their next review date.
order	string	The name of the field to order by first.
order2	string	The name of the field to order by second.
order3	string	The name of the field to order by third.
order4	string	The name of the field to order by fourth.
order5	string	The name of the field to order by fifth.
orderdesc	boolean	Whether to order ascending or descending on first order.
orderdesc2	boolean	Whether to order ascending or descending on second order.
orderdesc3	boolean	Whether to order ascending or descending on third order.
orderdesc4	boolean	Whether to order ascending or descending on fourth order.
orderdesc5	boolean	Whether to order ascending or descending on fifth order.
organisation_id	integer	Filters by Knowledge Base Articles belonging to a particular organisation.
page_no	integer	When using pagination, the page number to return.
page_size	integer	When using pagination, the size of the page.
pageinate	boolean	Whether to use pagination in the response.
related_to	integer	Filters response based on the related Knowledge Base Article.
related_to_ticket	integer	Filters response based on the related ticket.
search	string	Filters response based on the search string.
site_id	integer	Filters by the specified site.
type	integer	Filters response based on the Knowledge Base Article type.

Responses:

• 200 OK — Returns a KBEntry_View object (paginated list of KB entries).
• 400 Bad Request
• 401 Unauthorized
• 429 Too Many Requests

---

POST /KBArticle

Creates one or more KB entries.

Request Body: Array of KBEntry objects.

Responses:

• 201 Created — Returns the created KBEntry object.
• 400 Bad Request
• 401 Unauthorized
• 429 Too Many Requests

---

GET /KBArticle/{id}

Summary: Get one KBEntry

Returns a single KBEntry by ID. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	ID of the KB article.

Query Parameters:

Name	Type	Description
includedetails	boolean	Include extra objects in the response.
language_code	string	Language code filter.
language_override	string	Language override value.
organisation_id	integer	Filter by organisation ID.

Responses:

• 200 OK — Returns a KBEntry object.
• 400 Bad Request
• 401 Unauthorized
• 404 Not Found
• 429 Too Many Requests

---

DELETE /KBArticle/{id}

Deletes a KB article by ID.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	ID of the KB article to delete.

Responses:

• 200 OK

---

POST /KBArticle/vote

Submits a vote on a KB article.

Request Body: Array of KBEntry objects (used to carry vote data).

Responses:

• 200 OK

---

KBEntryAnon

GET /KBArticleAnon

Returns KB articles accessible without authentication.

Responses:

• 200 OK

---

GET /KBArticleAnon/{slug}

Returns a single anonymous KB article by slug.

Path Parameters:

Name	Type	Required	Description
slug	string	Yes	URL slug of the KB article.

Responses:

• 200 OK

---

FAQListHead

GET /FAQLists

Summary: List of FAQListHead

Returns multiple FAQ list headers. Requires authentication.

Query Parameters:

Name	Type	Description
allgroups	boolean	Include all groups in response.
endoftreeonly	boolean	Return only end-of-tree nodes.
level	integer	Filter by hierarchy level.
organisation_id	integer	Filter by organisation ID.
parent_id	integer	Filter by parent FAQ list ID.
showcounts	boolean	Include article counts in response.
type	integer	Filter by FAQ list type.

Responses:

• 200 OK

---

POST /FAQLists

Creates one or more FAQ list headers.

Request Body: Array of FAQListHead objects.

Responses:

• 200 OK

---

GET /FAQLists/{id}

Summary: Get one FAQListHead

Returns a single FAQ list header by ID. Requires authentication.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	ID of the FAQ list.

Query Parameters:

Name	Type	Description
includedetails	boolean	Include extra objects in the response.
organisation_id	integer	Filter by organisation ID.

Responses:

• 200 OK

---

DELETE /FAQLists/{id}

Deletes a FAQ list header by ID.

Path Parameters:

Name	Type	Required	Description
id	integer	Yes	ID of the FAQ list to delete.

Responses:

• 200 OK

---

Search

GET /Search

Summary: List of Search

Returns search results across Knowledge Base content. Requires authentication.

Query Parameters:

Name	Type	Description
count_per_entity	integer	Maximum number of results to return per entity type.
search	string	Search string to query against KB content.

Responses:

• 200 OK

---