Query tickets with filters

Query tickets with complex filtering including metadata filters

Query tickets with filters

post

Query tickets with complex filtering including metadata filters

Body

application/json

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 200OptionalDefault: 25

sort_bystring · enumOptionalDefault: created_atPossible values:

sort_directionstring · enumOptionalDefault: descPossible values:

titlestring · nullableOptional

descriptionstring · nullableOptional

reporterstring[] · nullableOptional

assigneestring[] · nullableOptional

Use 'UNASSIGN' for unassigned

desk_idstring[] · nullableOptional

subdesk_idstring[] · nullableOptional

Filter by subdesk (team) IDs

tag_idsinteger[] · nullableOptional

tag_namesstring[] · nullableOptional

vip_reporterboolean · nullableOptional

Filter tickets by VIP status of the reporter employee

location_reporterstring[] · nullableOptional

Filter tickets by location of the reporter employee

Responses

200

Successful Response

application/json

total_countintegerRequired

422

Validation Error

application/json

post/api/v1/tickets/query

HTTPcURLJavaScriptPython

POST /service-desk/api/v1/tickets/query HTTP/1.1
Host: api.harmony.io
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "page": 1,
  "page_size": 25,
  "sort_by": "created_at",
  "sort_direction": "desc",
  "title": "text",
  "description": "text",
  "ticket_type": [
    "request"
  ],
  "priority": [
    "low"
  ],
  "status": [
    "open"
  ],
  "reporter": [
    "text"
  ],
  "assignee": [
    "text"
  ],
  "desk_id": [
    "text"
  ],
  "subdesk_id": [
    "text"
  ],
  "tag_ids": [
    1
  ],
  "tag_names": [
    "text"
  ],
  "source": [
    "slack"
  ],
  "vip_reporter": true,
  "location_reporter": [
    "text"
  ],
  "metadata_filters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "ticket_type": "request",
      "priority": "low",
      "source": "slack",
      "status": "open",
      "reporter": "text",
      "created_by": "text",
      "assignee": "text",
      "desk_id": "text",
      "subdesk_id": "text",
      "created_at": "2026-08-11T06:10:44.594Z",
      "updated_at": "2026-08-11T06:10:44.594Z",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ticket_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "kb_resolution": {
        "answer_summary": "text",
        "sources": [
          {
            "url": "text",
            "title": "text"
          }
        ],
        "chunks_count": 1,
        "confidence": 1,
        "queried_at": "2026-08-11T06:10:44.594Z"
      },
      "workflows": [
        {
          "workflow_id": "text",
          "name": "text",
          "description": "text",
          "workflow_target": "text"
        }
      ],
      "tags": [
        {
          "id": 1,
          "desk_id": "text",
          "name": "text",
          "color": "text",
          "description": "text",
          "system_tag": true,
          "created_at": "2026-08-11T06:10:44.594Z",
          "updated_at": "2026-08-11T06:10:44.594Z"
        }
      ],
      "related_asset_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "thread_id": "123e4567-e89b-12d3-a456-426614174000",
      "response_sla_deadline": "2026-08-11T06:10:44.594Z",
      "response_sla_completed_at": "2026-08-11T06:10:44.594Z",
      "resolution_sla_deadline": "2026-08-11T06:10:44.594Z",
      "resolution_sla_completed_at": "2026-08-11T06:10:44.594Z"
    }
  ],
  "total_count": 1
}