/tickets/maverick/categories

GET /tickets/maverick/categories

Get Maverick categories with mapping status

Retrieve all Maverick ticket categories with their current Pulse ticket type mapping status

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

Try it out

Output:

Responses

Description

Categories with mapping status retrieved successfully

{
  "data": [
    {
      "id": 123,
      "name": "Chargebacks",
      "group": "Risk",
      "parent": {
        "id": 0,
        "name": "string"
      },
      "mapping": {
        "id": 1,
        "pulseTicketTypeId": "tt-xyz123",
        "pulseTicketTypeName": "Chargeback Disputes",
        "pulseCategoryEnum": "billing",
        "isMapped": true
      }
    }
  ],
  "totalCount": 49,
  "mappedCount": 15,
  "unmappedCount": 34,
  "_meta": {
    "source": "maverick",
    "description": "Maverick ticket categories with their Pulse ticket type mapping status"
  }
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/MaverickCategoryWithMapping

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/MaverickCategoryWithMapping

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    description: Maverick category ID
    example: 123
  name:
    type: string
    description: Maverick category name
    example: Chargebacks
  group:
    type: string
    description: Maverick category group
    example: Risk
  parent:
    type: object
    nullable: true
    properties:
      id:
        type: integer
      name:
        type: string
  mapping:
    type: object
    description: Current Pulse ticket type mapping status
    properties:
      id:
        type: integer
        nullable: true
        description: Mapping database ID (null if unmapped)
        example: 1
      pulseTicketTypeId:
        type: string
        nullable: true
        description: Pulse ticket type ID (null if unmapped)
        example: tt-xyz123
      pulseTicketTypeName:
        type: string
        nullable: true
        description: Pulse ticket type name (null if unmapped)
        example: Chargeback Disputes
      pulseCategoryEnum:
        type: string
        nullable: true
        description: Pulse category enum (null if unmapped)
        example: billing
      isMapped:
        type: boolean
        description: Whether this category is mapped to a Pulse ticket type
        example: true

|
export interface MaverickCategoryWithMapping {
  /** Maverick category ID */
  id?: number;
  /** Maverick category name */
  name?: string;
  /** Maverick category group */
  group?: string;
  parent?: { id?: number; name?: string };
  /** Current Pulse ticket type mapping status */
  mapping?: {
    id?: number;
    pulseTicketTypeId?: string;
    pulseTicketTypeName?: string;
    pulseCategoryEnum?: string;
    isMapped?: boolean;
  };
}

Route Source Code

Check out the source code for this route entrypoint here: /tickets/maverick/categories/route.ts

Or the swagger.yaml spec this documentation was generated from: /tickets/maverick/swagger.yaml