Configuration Archives

Authentication is required for this route. The authenticated user will be able to retrieve ticket replies for tickets to which they have access. They will also be able to create new ticket replies. It is recommended that a user with the role of Support Manager or higher is used.

Schema #

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

`id` integer	Unique identifier for the ticket reply Read Only
`date` string	The date the reply was published, in the site’s timezone
`date_gmt` string	The date the reply was published, as GMT
`modified` string	The date the reply was last modified, in the site’s timezone
`modified_gmt` string	The date the reply was last modified, as GMT
`status` string	The named status of the reply One of: `publish`
`content` object	The content for the reply
`ticket_data` object	Ticket fields See Ticket Data Object
`links` object	Links associated with the ticket
Ticket Data Object # The following fields are included within the ticket_data object
`id` integer	Unique WP Post identifier for the ticket
`number` string	Unique identifier for the ticket
`key` string	Unique key for the ticket
`status` string	The named status of the ticket One of: `new, open, hold, closed` – additional values may be available if the KBS Custom Ticket Status extension is installed
`title` string	The title of the ticket

Retrieve a List Replies of Ticket #

Query this endpoint to retrieve a collection of replies for the given ticket ID. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /kbs/v1/replies/ticket/<id>

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 post IDs
`include`	Limit result set to specific post 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`, `date`, `agent`, `customer`, `modified`, `include`
`customer`	Limit result set to tickets logged by customers with a specific KBS user ID
`agent`	Limit result set to tickets assigned to an agent with a specific WP user ID

Retrieve a Single Ticket Reply #

Definition #

GET /kbs/v1/replies/<id>

Example Request #

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

Arguments #

`id`	WP Post ID of the ticket

Add a New Ticket Reply #

Arguments #

`id` integer *required*	Unique WP Post ID of ticket to which to add reply
`reply_content` text *required*	The content of the ticket reply
`reply_author` integer	WP User ID of reply author Default: `Current user ID`
`agent` integer	User ID or email address of agent from whom reply is being authored
`ticket_status` string	The status to update the ticket to once the reply is added One of: `open, hold, closed` – or any custom status registered via the KBS Custom Ticket Status extension if installed
`close_ticket` bool	A `true` closes the ticket once the reply is added Default: `false`

Definition #

POST /kbs/v1/replies/ticket/<id>

Example Request #

$ curl -X POST https://example.com/wp-json/kbs/v1/replies/ticket/<id> -d '{"reply_content":"This is my reply"}'

12th January 2021

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

12th January 2021

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

`id` integer	Unique identifier for the company Read Only
`title` object	The name of the company
`slug` string	An alphanumeric identifier for the object unique to its type
`featured_media` integer	ID of the featured media for the object (generally compant logo)
`meta` object	Contains contact information for the company Contains: `_kbs_company_customer`, `_kbs_company_contact`, `_kbs_company_email`, `_kbs_company_phone`, `_kbs_company_website`
`links` object	Links associated with the company

List Company #

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

Definition #

GET /kbs/v1/companies

Example Request #

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

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 company IDs
`include`	Limit result set to specific company 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`, `user_id`, `name`, `email`, `company_id`, `date`
`search`	Limit result set to specific search string

Retrieve a Single Company #

Definitions #

GET /kbs/v1/tickets/<id>

GET /kbs/v1/tickets/<number>

Example Requests #

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

Arguments #

`id`	WP Post ID of the ticket

12th January 2021

Ticket Categories REST API Route

Authentication #

Authentication is only required for this route if you are adding or editing categories.

Schema #

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

`id` integer	Unique identifier for the term Read Only
`count` integer	Number of tickets for the term Read Only
`description` string	HTML description of the term
`link` string	URL of the term Read Only
`name` string	HTML title for the term
`slug` string	An alphanumeric identifier for the term unique to its type
`taxonomy` string	Type attribution for the term Read Only
`parent` integer	The parent term ID
`meta` object	Meta fields

List Ticket Categories #

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

Definition #

GET /wp/v2/ticket_categories

Example Request #

$ curl https://example.com/wp-json/wp/v2/ticket_categories

Arguments #

`context`	Scope under which the request is made; determines fields present in response Default: `view` One of: `view`, `embed`, `edit`
`page`	Current page of the collection Default: `1`
`per_page`	Maximum number of items to be returned in result set Default: `10`
`search`	Limit results to those matching a string
`exclude`	Ensure result set excludes specific IDs
`include`	Limit result set to specific IDs
`order`	Order sort attribute ascending or descending Default: `asc`One of: `asc`, `desc`
`orderby`	Sort collection by term attribute Default: `name`One of: `id`, `include`, `name`, `slug`, `include_slugs`, `term_group`, `description`, `count`
`hide_empty`	Whether to hide terms not assigned to any posts
`parent`	Limit result set to terms assigned to a specific parent
`post`	Limit result set to terms assigned to a specific ticket
`slug`	Limit result set to terms with one or more specific slugs

Create a Ticket Category #

Arguments #

`description`	HTML description of the term
`name` Required	HTML title for the term.
`slug`	An alphanumeric identifier for the term unique to its type
`parent`	The parent term ID
`meta`	Meta fields

Definition #

POST /wp/v2/ticket_categories

Retrieve a Ticket Category #

Definition #

GET /wp/v2/ticket_categories/<id>

Example Request #

$ curl https://example.com/wp-json/wp/v2/ticket_categories/<id>

Arguments #

`id`	Unique identifier for the term
`context`	Scope under which the request is made; determines fields present in response Default: `view` One of: `view`, `embed`, `edit`

Update a Ticket Category #

Arguments #

`id`	Unique identifier for the term
`description`	HTML description of the term
`name`	HTML title for the term
`slug`	An alphanumeric identifier for the term unique to its type
`parent`	The parent term ID
`meta`	Meta fields

Definition #

POST /wp/v2/ticket_categories/<id>

Example Request #

$ curl -X POST https://example.com/wp-json/wp/v2/ticket_categories/<id> -d '{"description":"My ticket term"}'

Delete a Ticket Category #

Arguments #

`id`	Unique identifier for the term
`force`	Required to be true, as terms do not support trashing

Definition #

DELETE /wp/v2/ticket_categories/<id>

Example Request #

$ curl -X DELETE https://example.com/wp-json/wp/v2/ticket_categories/<id>

12th January 2021

Ticket Departments REST API Route

Authentication #

Authentication is only required for this route if you are adding or editing departments.

Schema #

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

`id` integer	Unique identifier for the term Read Only
`count` integer	Number of tickets for the term Read Only
`description` string	HTML description of the term
`link` string	URL of the term Read Only
`name` string	HTML title for the term
`slug` string	An alphanumeric identifier for the term unique to its type
`taxonomy` string	Type attribution for the term Read Only
`parent` integer	The parent term ID
`meta` object	Meta fields

List Ticket Department Categories #

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

Definition #

GET /wp/v2/ticket_departments

Example Request #

$ curl https://example.com/wp-json/wp/v2/ticket_departments

Arguments #

`context`	Scope under which the request is made; determines fields present in response Default: `view` One of: `view`, `embed`, `edit`
`page`	Current page of the collection Default: `1`
`per_page`	Maximum number of items to be returned in result set Default: `10`
`search`	Limit results to those matching a string
`exclude`	Ensure result set excludes specific IDs
`include`	Limit result set to specific IDs
`order`	Order sort attribute ascending or descending Default: `asc`One of: `asc`, `desc`
`orderby`	Sort collection by term attribute Default: `name`One of: `id`, `include`, `name`, `slug`, `include_slugs`, `term_group`, `description`, `count`
`hide_empty`	Whether to hide terms not assigned to any posts
`parent`	Limit result set to terms assigned to a specific parent
`post`	Limit result set to terms assigned to a specific ticket
`slug`	Limit result set to terms with one or more specific slugs

Create a Ticket Department #

Arguments #

`description`	HTML description of the term
`name` Required	HTML title for the term.
`slug`	An alphanumeric identifier for the term unique to its type
`parent`	The parent term ID
`meta`	Meta fields

Definition #

POST /wp/v2/ticket_departments

Retrieve a Ticket Department #

Definition #

GET /wp/v2/ticket_departments/<id>

Example Request #

$ curl https://example.com/wp-json/wp/v2/ticket_departments/<id>

Arguments #

`id`	Unique identifier for the term
`context`	Scope under which the request is made; determines fields present in response Default: `view` One of: `view`, `embed`, `edit`

Update a Ticket Department #

Arguments #

`id`	Unique identifier for the term
`description`	HTML description of the term
`name`	HTML title for the term
`slug`	An alphanumeric identifier for the term unique to its type
`parent`	The parent term ID
`meta`	Meta fields

Definition #

POST /wp/v2/ticket_departments/<id>

Example Request #

$ curl -X POST https://example.com/wp-json/wp/v2/ticket_departments/<id> -d '{"description":"My department term"}'

Delete a Ticket Department #

Arguments #

`id`	Unique identifier for the term
`force`	Required to be true, as terms do not support trashing

Definition #

DELETE /wp/v2/ticket_departments/<id>

Example Request #

$ curl -X DELETE https://example.com/wp-json/wp/v2/ticket_departments/<id>

12th January 2021

Using the REST API

You can use the KB Support REST API to retrieve information regarding Tickets, Customers and Agents via 3rd party applications. You can also use the REST API to remotely create content such as tickets and replies.

12th January 2021

Tickets REST API Route

Authentication #

Authentication is required for this route. The authenticated user will be able to retrieve and update tickets to which they have access. They will also be able to create new tickets. It is recommended that a user with the role of Support Manager or higher is used.

Schema #

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

`id` integer	Unique identifier for the ticket Read Only
`date` string	The date the ticket was published, in the site’s timezone
`date_gmt` string	The date the ticket was published, as GMT
`modified` string	The date the ticket was last modified, in the site’s timezone
`modified_gmt` string	The date the ticket was last modified, as GMT
`status` string	The named status of the ticket One of: `new, open, hold, closed` – additional values may be available if the KBS Custom Ticket Status extension is installed
`title` object	The title of the ticket
`content` object	The content for the ticket
`ticket_data` object	Ticket fields See Ticket Data Object
`replies` integer	The count of replies associated with the ticket
`links` object	Links associated with the ticket
Ticket Data Object # The following fields are included within the ticket_data object
`resolved_date` string	The date the ticket was resolved, in local timezone
`number` string	Unique identifier for the ticket
`key` string	Unique key for the ticket
`files` object	Data of files associated with ticket
`agent` integer	WP user ID of agent assigned to the ticket
`additional_agents` object	WP user ID’s of additional agent workers of the ticket
`customer` integer	KBS user ID of the ticket customer
`email` string	Email address of the ticket customer
`user_id` integer	WP user ID of the ticket customer
`user_info` object	Ticket customer information
`company` integer	ID of company associated with the ticket
`participants` object	Email addresses of ticket participants
`form_data` object	The data that was submitted via a submission form

List Tickets #

Query this endpoint to retrieve a collection of tickets that the authenticated user has access to. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /kbs/v1/tickets

Example Request #

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

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 post IDs
`include`	Limit result set to specific post 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`, `date`, `title`, `agent`, `customer`, `modified`, `include`
`status` string \| array	Limit result set to tickets assigned one or more statuses Default: All registered ticket statusesOne of: `new, open, hold, closed` – or any custom status registered via the KBS Custom Ticket Status extension if installed
`user`	Limit result set to tickets logged by customers with a specific WP user ID
`customer`	Limit result set to tickets logged by customers with a specific KBS user ID
`company`	Limit result set to tickets associated with a specific company ID
`agent`	Limit result set to tickets assigned to an agent with a specific WP user ID

Retrieve a Single Ticket #

Definitions #

GET /kbs/v1/tickets/<id>

GET /kbs/v1/tickets/<number>

Example Requests #

Retrieve Ticket by WP Post ID
$ curl https://example.com/wp-json/kbs/v1/tickets/<id>

Retrieve Ticket by KBS Ticket Number
$ curl https://example.com/wp-json/kbs/v1/tickets/<number>

Arguments #

`id`	WP Post ID of the ticket
`number`	KBS ticket number

Create a Ticket #

Arguments #

`ticket_title` string *required*	The subject of the ticket
`ticket_content` text *required*	The content of the ticket
`customer_email` string *required*	Customers email address
`customer_first` string *required*	Customers first name
`customer_last` string *required*	Customers Last Name
`customer_phone1` string	Customers primary phone number
`customer_phone2` string	Customers additional phone number
`customer_website` string	Customers website address
`agent_id` integer \| string	WP user ID or email address of agent to be assigned to ticket
`post_category` integer	ID of category to which to add the ticket
`department` integer	ID of department to which to assign the ticket

Definition #

POST /kbs/v1/tickets

Update a Ticket #

Arguments #

`id` integer	WP Post ID of the ticket
`agent` integer \| string	WP user ID or email address of agent to be assigned to ticket
`agents` string	Comma separated list of agents to be added as workers of the ticket
`company` integer	ID of company to associate with ticket
`customer` integer \| string	KBS ID or email address of customer to associate with ticket
`status` string	The updated status of the ticket One of: `open, hold, closed` – or any custom status registered via the KBS Custom Ticket Status extension if installed
`post_category` integer	ID of a category to add to the ticket
`department` integer	ID of department to which to assign the ticket

Definition #

POST /kbs/v1/tickets/<id>

Example Request #

$ curl -X POST https://example.com/wp-json/kbs/v1/tickets/<id> -d '{"status":"closed"}'

12th January 2021

Articles REST API Route

Authentication #

Authentication is not required for this route unless attempting to retrieve restricted articles.

Schema #

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

`id` integer	Unique identifier for the article Read Only
`date` string	The date the article was published, in the site’s timezone
`date_gmt` string	The date the article was published, as GMT
`modified` string	The date the article was last modified, in the site’s timezone
`modified_gmt` string	The date the article was last modified, as GMT
`guid` object	The globally unique identifier for the object. Read only
`slug` string	An alphanumeric identifier for the object unique to its type
`status` string	The named status of the article One of: `publish`, `future`, `draft`, `pending`, `private`
`type` string	Type of Post for the object Read only
`title` object	The title of the article
`content` object	The content of the article
`excerpt` object	The excerpt for the object
`author` integer	The ID for the author of the object
`replies` integer	The count of replies associated with the ticket
`links` object	Links associated with the ticket

List Articles #

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

Definition #

GET /kbs/v1/articles

Example Request #

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

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 article IDs
`include`	Limit result set to specific article 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: `author`, `date`, `id`, `include`, `modified`, `parent`, `relevance`, `slug`, `include_slugs`, `title`, `views`, `views_month`
`status` string \| array	Limit result set to articles assigned one or more statuses Default: `publish`
`search` string	Limit results to those matching a string

Retrieve an Article #

Definition #

GET /kbs/v1/articles/<id>

Example Request #

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

Arguments #

`id`	WP Post ID of the ticket

12th January 2021

Authentication #

Schema #

List Forms #

Definition #

Example Request #

Arguments #

Retrieve a Single Form #

Definitions #

Example Request #

Arguments #

Authentication #

Schema #

List Fields #

Definition #

Example Request #

Arguments #

Retrieve a Single Field #

Definitions #

Example Request #

Arguments #

Authentication #

Schema #

Retrieve a List Replies of Ticket #

Definition #

Arguments #

Retrieve a Single Ticket Reply #

Definition #

Example Request #

Arguments #

Add a New Ticket Reply #

Arguments #

Definition #

Example Request #

Authentication #

Schema #

List Customers #

Definition #

Example Request #

Arguments #

Retrieve a Single Customer #

Definition #

Example Request #

Arguments #

Authentication #

Schema #

List Company #

Definition #

Example Request #

Arguments #

Retrieve a Single Company #

Definitions #

Example Requests #

Arguments #

Authentication #

Schema #

List Ticket Categories #

Definition #

Example Request #

Arguments #

Create a Ticket Category #

Arguments #

Definition #

Retrieve a Ticket Category #

Definition #

Example Request #

Arguments #

Update a Ticket Category #

Arguments #

Definition #

Example Request #

Delete a Ticket Category #

Arguments #

Definition #

Example Request #

Authentication #

Schema #

List Ticket Department Categories #

Definition #

Example Request #

Arguments #