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.
When working with the Customers REST API route the following fields can be expected in any responses.
|Unique identifier for the customer|
|The name of the customer|
|The WP user ID of the customer|
|The email address of the customer|
|List of additional email addresses of the customer|
|Primary and additional phone numbers of the customer|
|Website address of the customer|
|Address of the customer|
|ID of the company for which the customer is associated|
|Date the customer was created in website timezone|
|List of notes added against the customer|
|Number of tickets that the customer has logged|
List Customers #
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.
Example Request #
$ curl https://example.com/wp-json/kbs/v1/customers
|Current page of the collection|
|Maximum number of items to be returned in result set|
|Ensure result set excludes specific customer IDs|
|Limit result set to specific customerIDs|
|Offset the result set by a specific number of items|
|Order sort attribute ascending or descending|
|Sort collection by object attribute|
|Limit result set to specific customer WP user ID’s|
|Limit result set to specific email addresses|
|Limit result set to specific customer names|
|Limit result set to customers associated with a specific company ID|
Retrieve a Single Customer #
Example Request #
$ curl https://example.com/wp-json/kbs/v1/customers/<id>
|ID or email address of the customer to retrieve|
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.