On this page
API for Customer Portal (Knowledge Base/Suggestions)
Customer Portal API Reference
Table of Contents
Knowledge Base Search
API Overview
- Compatible Version: LiveAgent version 4.7.3.0 and later
Request Method
GET http://example.com/api/knowledgebase/search?query=[value]&apikey=[value]
Required Parameters
| Parameter Name | Format | Content |
|---|---|---|
| query | text | Search query string |
| apikey | text | API key |
Optional Parameters
| Parameter Name | Format | Content |
|---|---|---|
| top_article_id | text | Top article ID. Start search from specified ID |
Response Fields
articles: Knowledge base article listkb_entry_id: Article IDurlcode: Article URL IDtitle: Title- See other detailed field references
Response Example
- XML and JSON format sample responses available
Suggestion Categories List
API Overview
- Compatible Version: LiveAgent version 2.8.2.1 and later
Request Method
GET http://example.com/api/suggestioncategories?apikey=[value]
Required Parameters
| Parameter Name | Format | Content |
|---|---|---|
| apikey | text | API key |
Response Fields
suggestioncategories: Suggestion categories listid: Category IDtitle: Category titlepath: Category path
Response Example
- XML and JSON format sample responses available
