Menu Close Menu
Menu
  • 0
    • Number of items in cart: 0

      • Your cart is empty.
      • Total: $0.00
      • Checkout
  • Pricing
    • Purchase Options
    • Individual Extensions
  • Support
    • Documentation
    • Log a Support Ticket
  • Your Account
    • Register
  • Blog

Using the REST API

Using the REST API

Integrate thousands of 3rd party applications with KB Support

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.

Using the REST API

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…
KB Article rating: 5.0 based on 1 ratings
Advanced Developer Docs REST API Last updated: 21/01/2021

Published by Cristian Raiber

Posts by Cristian Raiber

Post navigation

Previous

Ticket Source REST API Route

Next

Replies REST API Route

Contact Details

  • Follow us on Twitter
  • Like us on Facebook
  • Fork us on GitHub

Developer Resources

Plugin Boilerplate

Trello Board

GitHub Repository

Ratings & Satisfaction Docs

  • Configuring Ratings and Satisfaction
  • Advanced Settings

Email Support Docs

  • Plugin Requirements
  • Configuring Email Support
  • Creating New Tickets
  • Replying to Closed Tickets
  • Anonymous Replies in Email Support
  • HTML Emails Tags
  • Email Commands
  • Defining IMAP Flags

KBS REST API Docs

  • Using the REST API
  • Tickets REST API Route
  • Replies REST API Route
  • Articles REST API Route
  • Agents REST API Route
  • Customers REST API Route
  • Companies REST API Route
  • Forms REST API Route
  • Form Fields REST API Route
  • Ticket Categories REST API Route
  • Ticket Departments REST API Route
  • Ticket Source REST API Route

Article Categories

  • Configuration
    • Advanced
    • Getting Started
  • Developer Docs
    • Constants
    • Hooks
  • Extensions
  • FAQs
© 2023 KB Support. All rights reserved.
  • Blog
  • Shop
  • Support
  • Privacy Policy
  • Discount Code