Customers REST API Route

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 Customers REST API route the following fields can be expected in any responses.

id
integer		 Unique identifier for the customer
Read Only
name
string		 The name of the customer
user_id
integer		 The WP user ID of the customer
email
string		 The email address of the customer
additional_emails
object		 List of additional email addresses of the customer
phone
object		 Primary and additional phone numbers of the customer
website
string		 Website address of the customer
address
string		 Address of the customer
company
integer		 ID of the company for which the customer is associated
date_created
string		 Date the customer was created in website timezone
notes
object		 List of notes added against the customer
ticket_count
integer		 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.

Definition #

GET /kbs/v1/customers

Example Request #

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

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 customer IDs
include Limit result set to specific customerIDs
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, user_id, name, email, company_id, date
user_id Limit result set to specific customer WP user ID’s
email Limit result set to specific email addresses
name Limit result set to specific customer names
company Limit result set to customers associated with a specific company ID

Retrieve a Single Customer #

Definition #

GET /kbs/v1/agents/<id>

Example Request #

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

Arguments #

id ID or email address of the customer to retrieve

Was this article helpful?