Skip to content
Proud to collaborate with Microsoft for Startups

ticket.get ​

Hydrated read of one ticket: ledger row, children, and live-resolved source.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-tickets
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes—Organization that owns the ticket; injected from authenticated context.
ticket_uuidstringYes—Public UUID of the ticket to retrieve.
includelistNo—Related blocks to include: triggers, links, events, or plans.
hydratebooleanNo—Resolve linked workflow runs into the best-effort live block; defaults true.
body_offsetintegerNo—Character offset into ticket/event bodies when body_limit is set.
body_limitintegerNo—Optional max characters per body field; omit to return the full stored body.
events_limitintegerNo—Max timeline events when include contains events (default 100, max 500).
events_cursorstringNo—Keyset cursor from a previous events_next_cursor.
events_orderstringNo—Timeline order when include contains events: asc (default) or desc.

Output Schema ​

FieldTypeRequiredDefaultDescription
ticketdictNo—Canonical ticket ledger record.
triggerslistNo—Scheduled actions attached to the ticket when requested.
linkslistNo—Typed links to tickets, workflow runs, and ecosystem objects.
eventslistNo—One page of immutable ticket timeline events when requested.
events_next_cursorstringNo—Keyset cursor for the next events page; null when the page is complete.
planslistNo—Agent-authored fix plans when requested.
lifecycledictNo—Statuses, priority choices, aliases, and allowed transition map.
livedictNo—Best-effort current state of linked workflow evidence and subject.
errorstringNo—Error-as-field envelope populated when query() raises.
error_typestringNo—Error-as-field envelope populated when query() raises.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "ticket.get",
  "initial_data": {
    "organization_uuid": "value",
    "ticket_uuid": "value"
  }
}