Introduction

Your guide to building with Harmony autonomous IT platform

Welcome to Harmony! This guide covers everything you need to integrate with our autonomous IT service management platform.

New to Harmony's API? Start with our Authentication section to get your first API call working in minutes.

IT Service Desk

Harmony transforms traditional IT support into an autonomous, AI-powered experience. Employees submit requests through any channel, and Harmony's AI handles each intelligently:

• Autonomous Resolution - AI resolves common requests instantly without human intervention
• Smart Routing - Tickets are automatically classified and assigned to the right teams
• Knowledge-Powered - Answers questions with accurate, sourced information from your knowledge base
• Seamless Escalation - Hands off to human agents with full context when needed

List Tickets

Query and filter tickets programmatically

Create Tickets

Submit tickets via API for custom integrations

Update Tickets

Modify ticket status, priority, and assignments

Get Activity

Track ticket history and changes

Base URL

Each organization has its own subdomain. Replace <customer_subdomain> with your organization's subdomain:

https://<customer_subdomain>.harmony.io

Example: If your organization is Acme Corp with subdomain acme, your API base URL is https://acme.harmony.io

Authentication

All API endpoints require authentication using AccessKey tokens:

curl -X GET https://<customer_subdomain>.harmony.io/api/v1/tickets \
  -H "Authorization: AccessKey YOUR_API_TOKEN"

To obtain an API token:

1. Log into your Harmony dashboard
2. Navigate to Settings > API Keys
3. Click Generate New API Key
4. Copy the token (it will only be shown once)

Keep your API tokens secure. Never commit them to source control or share them publicly.

Rate Limits

API requests are rate limited to ensure service stability:

Limit Type	Value
Per Hour	1,000 requests
Per Minute	100 requests

Rate limit information is included in response headers:

• X-RateLimit-Limit - Maximum requests allowed
• X-RateLimit-Remaining - Remaining requests in current window
• X-RateLimit-Reset - Unix timestamp when the rate limit resets

Response Format

All API responses follow a consistent JSON structure:

Success Response (200-299)

{
  "id": "ticket-123",
  "title": "Reset password request",
  "status": "open",
  "priority": "high",
  "created_at": "2024-01-15T10:30:00Z"
}

Error Response (400-599)

{
  "detail": "Ticket not found"
}

Integrations

Connect Harmony to 40+ tools for seamless IT operations:

Browse All Integrations

Explore our complete integration catalog including Slack, Teams, Okta, ServiceNow, Jira, and more

Need Help?

Contact Support

Reach out to our team at [e-mail]