Menu Close Menu
Menu
  • 0
    • Number of items in basket: 0

      • Your basket is empty.
      • Total: £0.00
      • Checkout
  • Blog
  • Extensions
  • Support
    • Documentation
    • Log a Support Ticket
  • Your Account
    • Register
  • Contact Us
  • Demo

Ticket Categories REST API Route

Ticket Categories REST API Route

List, update and create ticket categories via 3rd party applications

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 #

contextScope under which the request is made; determines fields present in response
Default: view
One of: view, embed, edit
pageCurrent page of the collection
Default: 1
per_pageMaximum number of items to be returned in result set
Default: 10
searchLimit results to those matching a string
excludeEnsure result set excludes specific IDs
includeLimit result set to specific IDs
orderOrder sort attribute ascending or descending
Default: asc
One of: asc, desc
orderbySort collection by term attribute
Default: name
One of: id, include, name, slug, include_slugs, term_group, description, count
hide_emptyWhether to hide terms not assigned to any posts
parentLimit result set to terms assigned to a specific parent
postLimit result set to terms assigned to a specific ticket
slugLimit result set to terms with one or more specific slugs

Create a Ticket Category #

Arguments #

descriptionHTML description of the term
name
Required
HTML title for the term.
slugAn alphanumeric identifier for the term unique to its type
parentThe parent term ID
metaMeta 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 #

idUnique identifier for the term
contextScope under which the request is made; determines fields present in response
Default: view
One of: view, embed, edit

Update a Ticket Category #

Arguments #

idUnique identifier for the term
descriptionHTML description of the term
nameHTML title for the term
slugAn alphanumeric identifier for the term unique to its type
parentThe parent term ID
metaMeta 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 #

idUnique identifier for the term
forceRequired 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>


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.

Share this:

  • Tweet
  • WhatsApp

Related Articles

Advanced Developer Docs REST API Last updated: 12th January 2021

Published by Michael

Mike is the founder and lead developer of KB Support. When he's not working on KB Support, he's generally spending time with his 3 children and following his favourite football team

Posts by Michael Visit Website

Post navigation

Previous

Ticket Source REST API Route

Next

Replies REST API Route

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

Social Links

  • Follow us on Twitter
  • Like us on Facebook
  • Fork us on GitHub

Resources

  • Contact Us
  • KB Support Discount Code
  • KB Support Demo Site
  • Easy Plugin Demo

Sign up to our newsletter!

Subscribe now to receive all the latest news, thoughts and offers from KB Support.
New subscribers will receive 15% off their first purchase.

Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.
To find out more, including how to control cookies, see here: Cookie Policy
© 2021 KB Support. All rights reserved.
  • Blog
  • Shop
  • Support
  • Demo
  • Privacy Policy
  • Discount Code