For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get a request

Returns a single request by ID

Get a single request

get

Returns a single request by ID

Authorizations
AuthorizationstringRequired

Harmony access key, sent as Authorization: AccessKey <your-key>. Create keys in Settings > Access Keys. The tenant is resolved from the key.

Path parameters
request_idstring · uuidRequired
Query parameters
include_classificationbooleanOptionalDefault: false
Responses
200

Successful Response

application/json

Single request response.

idstring · uuidRequired
thread_idstring · uuidRequired
employee_idstring · nullableRequired
desk_idstring · nullableRequired
agent_namestring · nullableRequired
categorystring · nullableRequired
subcategorystring · nullableRequired
sourcestringRequired
resolutionstring · nullableRequired

Who the request ended with: resolved_by_harmony (Harmony, including tickets closed while assigned to Harmony), escalated (handed off to a human, whether resolved, closed or canceled), a pending_* value while open, or null when not yet determined or withdrawn.

summarystring · nullableRequired
ticket_idstring · nullableRequired
ticket_typestring · nullableRequired
entitiesstring[]Required
symptomsstring[]Required
queried_atstring · date-timeRequired
resolution_atstring · date-time · nullableRequired
last_message_atstring · date-timeRequired
created_atstring · date-timeRequired
classificationstring · nullableOptional
classification_reasoningstring · nullableOptional
relevancestring · nullableOptional
ai_contributionstring · nullableOptional
human_contributionstring · nullableOptional
resolution_feedbackstring · nullableOptional
classified_atstring · date-time · nullableOptional
outcomestring · nullableOptional

How the AI contributed to the request (e.g. ai_resolved_direct, ai_assisted_submitted, manual_ticketed). Describes AI involvement, not who the request ended with; use resolution.

handlingstring · nullableOptional
get/api/v1/conversations/requests/{request_id}
GET /agents/api/v1/conversations/requests/{request_id} HTTP/1.1
Host: api.harmony.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "thread_id": "123e4567-e89b-12d3-a456-426614174000",
  "employee_id": "text",
  "desk_id": "text",
  "agent_name": "text",
  "category": "text",
  "subcategory": "text",
  "source": "text",
  "resolution": "text",
  "summary": "text",
  "ticket_id": "text",
  "ticket_type": "text",
  "entities": [
    "text"
  ],
  "symptoms": [
    "text"
  ],
  "queried_at": "2026-01-01T00:00:00.000Z",
  "resolution_at": "2026-01-01T00:00:00.000Z",
  "last_message_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "classification": "text",
  "classification_reasoning": "text",
  "relevance": "text",
  "ai_contribution": "text",
  "human_contribution": "text",
  "resolution_feedback": "text",
  "classified_at": "2026-01-01T00:00:00.000Z",
  "outcome": "text",
  "handling": "text",
  "search_match": {
    "location": "message",
    "snippet": "text",
    "field_label": "text"
  }
}

Last updated

Was this helpful?