You can use the KB Support REST API to retrieve information regarding Tickets, Customers and Agents via 3rd party applications. You can also use the REST API to remotely create content such as tickets and replies.
Configuring the REST API
The REST API requires no additional configuration and is ready for use. It was first introduced with the release of KB Support version 1.5.
Authentication
All of the KB Support REST endpoints with the exception of Articles, Ticket Categories and Departments, require authentication. Authentication can be achieved via any of the supported methods included within the WordPress REST API. Within our documentation, we will assume you are using application passwords as your authentication method.
Note that to list restricted articles, authentication is required.
Endpoints
The following endpoints are available within the KB Support REST API;
| Resource | Base Route |
|---|---|
| Tickets | /kbs/v1/tickets |
| Replies | /kbs/v1/replies |
| Articles | /kbs/v1/articles |
| Customers | /kbs/v1/customers |
| Companies | /kbs/v1/companies |
| Agents | /kbs/v1/agents |
| Ticket Categories | /wp/v2/ticket_categories |
| Departments | /wp/v2/ticket_departments |
| Ticket Sources | /wp/v2/ticket_sources |
Was this article helpful?
We're working hard to ensure we provide you with useful and relevant documentation to help you get the most out of KB Support.
Please take a moment to let us know if you found this article helpful.
