> For the complete documentation index, see [llms.txt](https://docs.harmony.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.harmony.io/api-references/api-documentation/introduction.md).

# Introduction

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

{% hint style="info" %}
New to Harmony's API? Start with our [Authentication](#authentication) section to get your first API call working in minutes.
{% endhint %}

### 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

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>List Tickets</strong></td><td>Query and filter tickets programmatically</td><td><a href="/pages/GNmNj9hRWvPm4Pm6Gogu">/pages/GNmNj9hRWvPm4Pm6Gogu</a></td></tr><tr><td><strong>Create Tickets</strong></td><td>Submit tickets via API for custom integrations</td><td><a href="/pages/8ey0FuTgDyFWccjRW6m4">/pages/8ey0FuTgDyFWccjRW6m4</a></td></tr><tr><td><strong>Update Tickets</strong></td><td>Modify ticket status, priority, and assignments</td><td><a href="/pages/LFso5FbrduCZ6xEmI6GI">/pages/LFso5FbrduCZ6xEmI6GI</a></td></tr><tr><td><strong>Get Activity</strong></td><td>Track ticket history and changes</td><td><a href="/pages/kq9vmhQNeEpsTng2fUaC">/pages/kq9vmhQNeEpsTng2fUaC</a></td></tr></tbody></table>

### Base URL

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

```
https://<customer_subdomain>.harmony.io
```

{% hint style="info" %}
Example: If your organization is Acme Corp with subdomain `acme`, your API base URL is `https://acme.harmony.io`
{% endhint %}

### Authentication

All API endpoints require authentication using AccessKey tokens:

```bash
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)

{% hint style="warning" %}
Keep your API tokens secure. Never commit them to source control or share them publicly.
{% endhint %}

### 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)**

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

**Error Response (400-599)**

```json
{
  "detail": "Ticket not found"
}
```

### Integrations

Connect Harmony to 40+ tools for seamless IT operations:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Browse All Integrations</strong></td><td>Explore our complete integration catalog including Slack, Teams, Okta, ServiceNow, Jira, and more</td><td><a href="https://github.com/harmonyso/public-docs/blob/main/integrations/overview.md">https://github.com/harmonyso/public-docs/blob/main/integrations/overview.md</a></td></tr></tbody></table>

### Need Help?

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Contact Support</strong></td><td>Reach out to our team at support@harmony.io</td><td><a href="mailto:support@harmony.io">mailto:support@harmony.io</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.harmony.io/api-references/api-documentation/introduction.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.