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

Customers REST API Route

Customers REST API Route

List customers 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 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?

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.

Developer Docs 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