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

      • Your basket is empty.
      • Total: £0.00
      • Checkout
  • Blog
  • Extensions
  • Support
    • Documentation
    • Log a Support Ticket
  • Your Account
    • Register
  • Contact Us
  • Demo

Agents REST API Route

Agents REST API Route

List agents via 3rd party applications

Authentication #

Authentication is required for this route and the authenticated user is required to have the ticket manager role. It is recommended that a user with the role of Support Manager or higher is used.

Schema #

When working with the Agents REST API route the following fields can be expected in any responses.

id
integer
Unique identifier for the agent
Read Only
name
string
The display name of the agent
first_name
string
The first name of the agent
last_name
string
The last name of the agent
email
string
The email address of the agent

List Agents #

Query this endpoint to retrieve a collection of KB Support agents. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /kbs/v1/agents

Example Request #

$ curl https://example.com/wp-json/kbs/v1/agents

Arguments #

pageCurrent page of the collection
Default: 1
per_pageMaximum number of items to be returned in result set
Default: 10
excludeEnsure result set excludes specific agent IDs
includeLimit result set to specific agent IDs
offsetOffset the result set by a specific number of items
orderOrder sort attribute ascending or descending
Default: desc
One of: asc, desc
orderbySort collection by object attribute
Default: id
One of: id, include, name, slug, email, registered_date
search
string
Limit result set to a search string

Retrieve a Single Agent #

Definition #

GET /kbs/v1/agents/<id>

Example Request #

$ curl https://example.com/wp-json/kbs/v1/agents/<id>

Arguments #

idWP User ID of the agent

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.

Share this:

  • Tweet
  • WhatsApp

Related Articles

Advanced Developer Docs REST API Last updated: 12th January 2021

Published by Michael

Mike is the founder and lead developer of KB Support. When he's not working on KB Support, he's generally spending time with his 3 children and following his favourite football team

Posts by Michael Visit Website

Post navigation

Previous

Ticket Source REST API Route

Next

Replies REST API Route

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

Social Links

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

Resources

  • Contact Us
  • KB Support Discount Code
  • KB Support Demo Site
  • Easy Plugin Demo

Sign up to our newsletter!

Subscribe now to receive all the latest news, thoughts and offers from KB Support.
New subscribers will receive 15% off their first purchase.

Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.
To find out more, including how to control cookies, see here: Cookie Policy
© 2021 KB Support. All rights reserved.
  • Blog
  • Shop
  • Support
  • Demo
  • Privacy Policy
  • Discount Code