/ticket-types

GET /ticket-types

Get all ticket types

Retrieve a paginated list of ticket types with optional filtering

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

Page number

pageSize query integer

Number of ticket types per page

search query string

Search all ticket types for any text that matches the search query (not case sensitive)

sort query string

Comma separated list of fields to sort by, prefix with - for descending order. (ie. sort=name,-createdAt)

category query string

Filter ticket types by category

isActive query boolean

Filter ticket types by active status

Try it out

Output:

Responses

Description

Successful response

{
  "data": [
    {
      "id": 0,
      "uniqueId": "string",
      "accountId": "string",
      "name": "string",
      "description": "string",
      "category": "string",
      "requiredPermissions": [
        "string"
      ],
      "isActive": false,
      "autoAssignmentEnabled": false,
      "rotationId": "string",
      "customFields": [
        {}
      ],
      "sortOrder": 0,
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0,
  "currentPage": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/TicketType #/components/schemas/TicketTypeList

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/TicketType

OpenAPI
TypeScript

type: object
description: Ticket type object representing a category/template for tickets
properties:
  id:
    type: integer
    description: Internal database ID
  uniqueId:
    type: string
    description: Unique identifier for the ticket type
  accountId:
    type: string
    description: ID of the account that owns this ticket type
  name:
    type: string
    description: Name of the ticket type
  description:
    type: string
    description: Description of the ticket type
  category:
    type: string
    description: Category of the ticket type
    enum:
      - technical
      - billing
      - account
      - compliance
      - feature_request
      - underwriting
      - general_support
      - general_forms
      - retention
      - activations
      - fee_change_forms
      - bank_submissions
  requiredPermissions:
    type: array
    items:
      type: string
    description: Array of permission strings required to create this ticket type
  isActive:
    type: boolean
    description: Whether this ticket type is active
  autoAssignmentEnabled:
    type: boolean
    description: Whether auto-assignment is enabled for this ticket type
  rotationId:
    type: string
    description: ID of the rotation to use for auto-assignment
  customFields:
    type: array
    items:
      type: object
    description: Custom field definitions for this ticket type
  sortOrder:
    type: integer
    description: Sort order for display purposes
  createdAt:
    type: string
    format: date-time
    description: When the ticket type was created
  updatedAt:
    type: string
    format: date-time
    description: When the ticket type was last updated
  createdBy:
    type: string
    description: Email of the user who created the ticket type
  updatedBy:
    type: string
    description: Email of the user who last updated the ticket type
required:
  - id
  - uniqueId
  - accountId
  - name
  - description
  - category

|
export interface TicketType {
  /** Internal database ID */
  id: number;
  /** Unique identifier for the ticket type */
  uniqueId: string;
  /** ID of the account that owns this ticket type */
  accountId: string;
  /** Name of the ticket type */
  name: string;
  /** Description of the ticket type */
  description: string;
  /** Category of the ticket type */
  category:
    | "technical"
    | "billing"
    | "account"
    | "compliance"
    | "feature_request"
    | "underwriting"
    | "general_support"
    | "general_forms"
    | "retention"
    | "activations"
    | "fee_change_forms"
    | "bank_submissions";
  /** Array of permission strings required to create this ticket type */
  requiredPermissions?: string[];
  /** Whether this ticket type is active */
  isActive?: boolean;
  /** Whether auto-assignment is enabled for this ticket type */
  autoAssignmentEnabled?: boolean;
  /** ID of the rotation to use for auto-assignment */
  rotationId?: string;
  /** Custom field definitions for this ticket type */
  customFields?: {}[];
  /** Sort order for display purposes */
  sortOrder?: number;
  /** When the ticket type was created */
  createdAt?: Date;
  /** When the ticket type was last updated */
  updatedAt?: Date;
  /** Email of the user who created the ticket type */
  createdBy?: string;
  /** Email of the user who last updated the ticket type */
  updatedBy?: string;
}

#/components/schemas/TicketTypeList

OpenAPI
TypeScript

type: object
properties:
  data:
    type: array
    items:
      $ref: "#/components/schemas/TicketType"
  totalCount:
    type: integer
  totalPages:
    type: integer
  currentPage:
    type: integer

|
export interface TicketTypeList {
  data?: TicketType[];
  totalCount?: number;
  totalPages?: number;
  currentPage?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /ticket-types/route.ts

Or the swagger.yaml spec this documentation was generated from: /ticket-types/swagger.yaml