How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Harmony

Harmony tickets API

The tickets API from Harmony — 6 operation(s) for tickets.

Documentation Provider Profile APIs.io OpenAPI GitHub

Harmony tickets API is published by Harmony on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Tickets. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 9 operations across 6 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.harmony.io/service-desk.

9 operations 6 paths 29 schemas 4 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.harmony.io/service-desk
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Harmony tickets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 4 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

tickets 9
POST
/api/v1/tickets/
Create a new ticket
createTicket body → 201422
GET
/api/v1/tickets/
List tickets
listTickets 18 params → 200422
GET
/api/v1/tickets/{ticket_id}
Get a ticket by ID
getTicketByID 1 param → 200422
PATCH
/api/v1/tickets/{ticket_id}
Update a ticket
updateTicket 1 param body → 200422
POST
/api/v1/tickets/query
Query tickets with filters
queryTickets body → 200422
POST
/api/v1/tickets/bulk-update
Bulk update tickets
bulkUpdateTickets body → 200422
GET
/api/v1/tickets/{ticket_id}/custom-fields
Get ticket custom fields
getTicketCustomFields 1 param → 200422
PUT
/api/v1/tickets/{ticket_id}/custom-fields
Set ticket custom fields
setTicketCustomFields 1 param body → 200422
GET
/api/v1/tickets/{ticket_id}/activity
Get ticket activity
getTicketActivity 3 params → 200422

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are TicketDetailResponse (27 properties), TicketResponse (25 properties), QueryTicketsRequest (19 properties), UpdateTicketRequest (18 properties). Each schema is shown below with its type and property counts.

CustomFieldValuesResponse
object
Response schema for custom field values.
1 property
AttachmentResponse
object
7 properties 7 required
TicketStatus
string
TicketsListResponse
object
2 properties 2 required
EventsResponse
object
Events response model matching CloudEvents structure.
6 properties 5 required
PaginatedResponseEventsResponse
object
PaginatedResponseEventsResponse
2 properties 2 required
WorkflowMetadata
object
Minimal workflow information for tickets.
4 properties 2 required
TicketDetailResponse
object
27 properties 13 required
TicketSource
string
BulkUpdateTicketsResponse
object
1 property 1 required
ValidationError
object
3 properties 3 required
CreateTicketRequest
object
15 properties 5 required
TicketResponse
object
25 properties 13 required
EventTag
object
Represents a tag with key-value structure.
2 properties 2 required
TicketType
string
HTTPValidationError
object
1 property
QueryTicketsRequest
object
19 properties
BulkUpdateTicketsRequest
object
5 properties 1 required
KBResolutionResponse
object
Knowledge base resolution suggestion for a ticket.
5 properties 3 required
AttachmentUploadStatus
string
CustomFieldValuesRequest
object
Request schema for setting custom field values on a ticket.
1 property 1 required
UpdateTicketRequest
object
18 properties
EventData
object
Event data payload with required actor and targets.
3 properties 2 required
TagResponse
object
8 properties 5 required
EventEntity
object
Represents the entity in the event can be Actor or Target of the event.
3 properties 2 required
KBSourceResponse
object
Knowledge base source citation.
2 properties 1 required
TicketPriority
string
WatcherResponse
object
5 properties 5 required
EntityType
string
Supported entity types in the Harmony platform (actors and targets).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harmony-tickets-api-openapi.yml Raw ↑
#Tickets
← Back to H APIs
API Details
ID
harmony:harmony-tickets-api
Base URL
https://api.harmony.io/service-desk
Docs
https://docs.harmony.io/api-references/api-documentation/introduction
Provider
Harmony
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=harmony-tickets-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/harmony-tickets-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Harmony tickets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.