---
title: "Get Helpdesk Ticket Overview"
method: GET
path: "/v1/data_extract/ticket_overview"
tags: ["Data Extract"]
---

# Get Helpdesk Ticket Overview

`GET /v1/data_extract/ticket_overview`

## Request

- Base URL: `https://api.capacity.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.capacity.com/v1/data_extract/ticket_overview`
- Auth: one of:
  - API key in header `x-capacity-id`
  - HTTP bearer

Get Helpdesk data. Results are paginated.

## Query parameters

- `page` integer
- `limit` integer
- `start_datetime` string, required
- `end_datetime` string, required
- `user_type` string

## Response `200`

A custom data array of Ticket Overview objects

- object
  - `body` object: Json body data in the request
  - `limit` integer: Number of results returned
  - `page` integer: Page of results returned
  - `parameters` object: Query parameters in the request
  - `result` TicketOverviewResponseSchema[]
    - `data` TicketOverviewSchema[]
      - `project_name` string: Name of the project associated with the helpdesk ticket
      - `ticket_key` string: The key associated with the helpdesk ticket, often used to look up the ticket or quickly search for it
      - `ticket_uuid` string: The unique identifier of the ticket in Capacity's system
      - `ticket_title` string: The title of the helpdesk ticket
      - `created_at` string, date-time: UTC timestamp when the ticket was created
      - `updated_at` string, date-time: UTC timestamp when the ticket was last updated
      - `last_transitioned_at` string, date-time: UTC timestamp when the ticket was last transitioned to its current state
      - `user_type` string: The type of user who created the ticket
    - `_meta` object

## Other responses

- `400`: The request contains malformed data or violates data integrity

---

[API](https://skmtc.dev/capacity/apis/capacity-api-docs.md) - [All operations](https://skmtc.dev/capacity/apis/capacity-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/capacity/apis/capacity-api-docs/revisions/74c85bb61004?raw)