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 #

page Current page of the collection
Default: 1
per_page Maximum number of items to be returned in result set
Default: 10
exclude Ensure result set excludes specific agent IDs
include Limit result set to specific agent IDs
offset Offset the result set by a specific number of items
order Order sort attribute ascending or descending
Default: desc
One of: asc, desc
orderby Sort 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 #

id WP 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.

Last updated: 23/08/2023

Published by Cristian Raiber

Posts by