Categories

Use the categories API operation to get a list of ticket categories.

Get categories

GET /categories
Accept: application/vnd.ticketing.v2+json

During ticket creation, a category for the ticket is required. Use this operation for the list of categories.

Request parameters

This operation does not accept a request body.

Response parameters

The response has the following body parameters within the categories list.

Name	Type	Description
ID	Int	ID for the category.
name	String	The category name. The categories are `Account`, `Billing and Payments`, `Request for Information`, `Change`, and `Incident`.
description	String	A description of the category.
classification	String	The classification of this category. The classifications are `Service Request`, `Change`, and `Incident`
subcategories	List	The list of subcategories for the category.
subcategories.name	String	The name of the subcategory.
subcategories.allowedProducts	String	The account product types that are allowed to use this subcategory.

Response example

The following example shows the JSON response for the request:

{
    "categories": [
        {
            "id": 1,
            "name": "Account",
            "description": "Account access, account settings, contact information, or managing users",
            "classification": "Service Request",
            "subcategories": [
                {
                    "name": "General",
                    "allowedProducts": [
                        "hybrid"
                    ]
                },
                {
                    "name": "Other",
                    "allowedProducts": [
                        "cloud",
                        "faws",
                        "managed_gcp"
                    ]
                }
            ]
        },
        {
            "id": 2,
            "name": "Billing and Payments",
            "description": "My bill, usage, my payments or payment options",
            "classification": "Service Request",
            "subcategories": [
                {
                    "name": "General",
                    "allowedProducts": [
                        "hybrid"
                    ]
                },
                {
                    "name": "Other",
                    "allowedProducts": [
                        "cloud",
                        "faws",
                        "managed_gcp"
                    ]
                }
            ]
        },
        {
            "id": 3,
            "name": "Change",
            "description": "Add/remove/modify infrastructure",
            "classification": "Change",
            "subcategories": [
                {
                    "name": "General",
                    "allowedProducts": [
                        "hybrid"
                    ]
                },
                {
                    "name": "Other",
                    "allowedProducts": [
                        "cloud",
                        "faws",
                        "managed_gcp"
                    ]
                }
            ]
        },
        {
            "id": 4,
            "name": "Incident",
            "description": "An unplanned interruption or reduction in service quality",
            "classification": "Incident",
            "subcategories": [
                {
                    "name": "General",
                    "allowedProducts": [
                        "hybrid"
                    ]
                },
                {
                    "name": "Other",
                    "allowedProducts": [
                        "cloud",
                        "faws",
                        "managed_gcp"
                    ]
                }
            ]
        },
        {
            "id": 5,
            "name": "Request for Information",
            "description": "General questions",
            "classification": "Service Request",
            "subcategories": [
                {
                    "name": "General",
                    "allowedProducts": [
                        "hybrid"
                    ]
                },
                {
                    "name": "Other",
                    "allowedProducts": [
                        "cloud",
                        "faws",
                        "managed_gcp"
                    ]
                }
            ]
        }
    ]
}

Response codes

This operation can have the following response codes:

Code	Name	Description
200	Success	The request succeeded.
429	Too Many Requests	The application has a built-in rate limit of 60 requests per minute. If you exceed this limit, you receive a 429 status code response until the cool off period has elapsed.