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.1.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.1.0

API Version

0.1.0

Base URL

https://api.harmony.io/service-desk

Authentication

HTTP Bearer

Resource Areas

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.

CustomFieldValuesRequest

object

Request schema for setting custom field values on a ticket.

1 property 1 required

TagResponse

object

8 properties 5 required

ValidationError

object

3 properties 3 required

BulkUpdateTicketsResponse

object

1 property 1 required

TicketStatus

string

BulkUpdateTicketsRequest

object

5 properties 1 required

WorkflowMetadata

object

Minimal workflow information for tickets.

4 properties 2 required

KBResolutionResponse

object

Knowledge base resolution suggestion for a ticket.

5 properties 3 required

KBSourceResponse

object

Knowledge base source citation.

2 properties 1 required

TicketSource

string

CreateTicketRequest

object

15 properties 5 required

EventsResponse

object

Events response model matching CloudEvents structure.

6 properties 5 required

UpdateTicketRequest

object

18 properties

EventData

object

Event data payload with required actor and targets.

3 properties 2 required

TicketsListResponse

object

2 properties 2 required

TicketDetailResponse

object

27 properties 13 required

EntityType

string

Supported entity types in the Harmony platform (actors and targets).

AttachmentUploadStatus

string

TicketResponse

object

25 properties 13 required

QueryTicketsRequest

object

19 properties

CustomFieldValuesResponse

object

Response schema for custom field values.

1 property

TicketPriority

string

AttachmentResponse

object

7 properties 7 required

HTTPValidationError

object

1 property

WatcherResponse

object

5 properties 5 required

TicketType

string

PaginatedResponseEventsResponse

object

PaginatedResponseEventsResponse

2 properties 2 required

EventTag

object

Represents a tag with key-value structure.

2 properties 2 required

EventEntity

object

Represents the entity in the event can be Actor or Target of the event.

3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#tickets

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Harmony tickets API

Metadata

Authentication & Security 1

Paths & Operations 9

Schemas 29

Specification

Source

API Details

Provider

Explore more