ticket.get ​
Hydrated read of one ticket: ledger row, children, and live-resolved source.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-tickets |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | Organization that owns the ticket; injected from authenticated context. |
ticket_uuid | string | Yes | — | Public UUID of the ticket to retrieve. |
include | list | No | — | Related blocks to include: triggers, links, events, or plans. |
hydrate | boolean | No | — | Resolve linked workflow runs into the best-effort live block; defaults true. |
body_offset | integer | No | — | Character offset into ticket/event bodies when body_limit is set. |
body_limit | integer | No | — | Optional max characters per body field; omit to return the full stored body. |
events_limit | integer | No | — | Max timeline events when include contains events (default 100, max 500). |
events_cursor | string | No | — | Keyset cursor from a previous events_next_cursor. |
events_order | string | No | — | Timeline order when include contains events: asc (default) or desc. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
ticket | dict | No | — | Canonical ticket ledger record. |
triggers | list | No | — | Scheduled actions attached to the ticket when requested. |
links | list | No | — | Typed links to tickets, workflow runs, and ecosystem objects. |
events | list | No | — | One page of immutable ticket timeline events when requested. |
events_next_cursor | string | No | — | Keyset cursor for the next events page; null when the page is complete. |
plans | list | No | — | Agent-authored fix plans when requested. |
lifecycle | dict | No | — | Statuses, priority choices, aliases, and allowed transition map. |
live | dict | No | — | Best-effort current state of linked workflow evidence and subject. |
error | string | No | — | Error-as-field envelope populated when query() raises. |
error_type | string | No | — | Error-as-field envelope populated when query() raises. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "ticket.get",
"initial_data": {
"organization_uuid": "value",
"ticket_uuid": "value"
}
}