> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--issue/types/objects/ticket.md).

# ticket

Represents a ticket or issue created in an external issue tracking system.

### Examples

```graphql
type Ticket {
  provider: Provider
  ticketId: String
  createdBy: String
  issueId: String
  issueName: String
  appName: String
  appId: String
  category: String
  assignee: String
  reporter: String
  link: String
  project: String
  issueType: String
  key: String
}
```

### Fields

| Field                                                                                                              | Description                                      | Supported fields |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | ---------------- |
| provider [`Provider`](https://docs.ox.security/api-documentation/api-reference/api--issue/types/enums/provider.md) | Ticket provider or system                        |                  |
| ticketId `String`                                                                                                  | Unique identifier of the ticket                  |                  |
| createdBy `String`                                                                                                 | User who created the ticket                      |                  |
| issueId `String`                                                                                                   | Associated issue ID                              |                  |
| issueName `String`                                                                                                 | Name or title of the associated issue            |                  |
| appName `String`                                                                                                   | Name of the application related to the issue     |                  |
| appId `String`                                                                                                     | ID of the application related to the issue       |                  |
| category `String`                                                                                                  | Category of the ticket                           |                  |
| assignee `String`                                                                                                  | User assigned to the ticket                      |                  |
| reporter `String`                                                                                                  | User who reported the ticket                     |                  |
| link `String`                                                                                                      | URL or link to the ticket in the external system |                  |
| project `String`                                                                                                   | Project name or identifier the ticket belongs to |                  |
| issueType `String`                                                                                                 | Type of issue                                    |                  |
| key `String`                                                                                                       | Key or short identifier of the ticket            |                  |

### References

#### Fields with this object:

* [{} Issue.tickets](https://docs.ox.security/api-documentation/api-reference/api--issue/types/objects/issue.md)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ox.security/api-documentation/api-reference/api--issue/types/objects/ticket.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
