> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unified Ticketing API

> Unified Ticketing API for support workflows across platforms, with consistent data models for ticket management, comments, and status tracking.

export const category_0 = "ticketing"

## What is a Unified API?

A **unified API** provides a single, standardized interface to interact with multiple third-party providers. Instead of learning each provider's unique API format, authentication scheme, and data model, you write code once, and StackOne handles the differences.

**What StackOne normalizes:**

* **Data models** – Consistent field names and structures across providers (e.g., `files` in Google Drive, SharePoint, and Dropbox all return the same schema; `users` in Google Workspace, Okta, and 1Password all return the same schema)
* **Authentication** – OAuth, API keys, and tokens are managed per-provider; you just pass an `x-account-id` header
* **Pagination** – Cursor-based pagination works the same regardless of whether the provider uses offsets, pages, or cursors
* **Error formats** – Standardized error responses with provider-specific details when available

<Tip>
  **Building AI agents?** Use the [MCP Server](/mcp/quickstart), an [AI Toolset SDK](/agents/typescript/introduction), or the [Actions API (RPC)](/platform/api-reference/actions/make-an-rpc-call-to-an-action) instead — same data, optimized for LLM tool calling.
</Tip>

## Benefits of the Ticketing API

<AccordionGroup>
  <Accordion title="Real-Time Data Synchronization">
    StackOne's APIs support real-time data polling, allowing for immediate updates and synchronization across platforms.
  </Accordion>

  <Accordion title="Privacy-First Design Ensuring Compliance">
    With a [focus on security](https://www.stackone.com/blog/why-your-choice-of-unified-api-could-make-or-break-compliance), StackOne's architecture avoids unnecessary data storage, maintaining compliance with data protection regulations.
  </Accordion>

  <Accordion title="Synthetic and Native Webhooks for Updates">
    Both [synthetic and native webhooks](/guides/webhooks), enable real-time notifications for tickets and comment events.
  </Accordion>

  <Accordion title="Comprehensive Integration Coverage">
    StackOne offers [pre-built connectors](https://www.stackone.com/integrations) with a wide range of {category_0} platforms, simplifying the integration process.
  </Accordion>
</AccordionGroup>

## Key Features

| **Feature**                    | **Description**                                                                          |
| ------------------------------ | ---------------------------------------------------------------------------------------- |
| Ticket Management              | Easily create and update tickets across multiple helpdesk platforms with unified fields  |
| Real-Time Data Synchronization | Keep ticket status, comments, and resolutions synchronized across all integrated systems |
| Real-Time Webhooks             | Receive instant notifications for ticket updates, comments, and status changes           |
| Monitor and Alerting           | Monitor ticket status and performance with alerts and notifications                      |

## StackOne SDKs & OpenAPI Specification

<p class="sdk-text">Use our official SDKs for faster integration. Build with language-native libraries. Full list [here](/guides/stackone-api-sdks).</p>

<CardGroup cols={2}>
  <Card title="OpenAPI Specification" icon="link" href="https://api.eu1.stackone.com/oas/ticketing.json" arrow="true" cta="Click here" />

  <Card title="Popular SDKs" icon="download" class="sdk-card">
    [Node.js](https://www.npmjs.com/package/@stackone/stackone-client-ts)
    [Java (JVM)](https://mvnrepository.com/artifact/com.stackone/stackone-client-java)
    [PHP](https://packagist.org/packages/stackone/client-sdk)
    [Ruby](https://rubygems.org/gems/stackone_client)
  </Card>
</CardGroup>

## Entity Model and Relationships

The following diagram illustrates the key entities within the Ticketing API:

```mermaid theme={null}
erDiagram
    COLLECTION {
      string id
      string parent_id
      string key
      string name
      string description
      enum type
    }
    TICKET {
        string id
        string parent_id
        object type
        string title
        object[] content
        string[] assignees
        string[] reporters
        object status
        object priority
        string creator_id
        string tags[]
        string ticket_url
    }
    COMMENT {
        string id
        string ticket_id
        object[] content
        string user_id
        boolean internal
    }
    ATTACHMENT {
        string id
        string ticket_id
        string file_name
        string file_type
        string file_url
        string size
        string url
        string user_id
    }

    COLLECTION ||--o{ COLLECTION : ""
    COLLECTION ||--o{ TICKET : ""
    TICKET ||--o{ COMMENT : ""
    TICKET ||--o{ ATTACHMENT : ""
```

## Entity Definitions

| Entity      | Description                                                                                  |
| ----------- | -------------------------------------------------------------------------------------------- |
| Collection  | A hierarchical grouping of tickets or other collections.                                     |
| Tickets     | Core support requests containing details about customer issues or service requests           |
| Comments    | Communications and updates related to tickets, including internal notes and customer replies |
| Attachments | Files and documents associated with tickets or comments                                      |