Playground

Playground

Ticket

/api/v1/helpdesk/tickets

A support ticket raised by an employee or customer.

listgetcreateupdateclose

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
numberstringHuman-readable ticket number, auto-assigned by the platform in the format TKT-NNNN.
titlestringShort summary of the ticket.
descriptionstringDetailed description of the issue or request. Markdown is supported.
typestringITSM classification of the ticket. 'incident' is an unplanned disruption; 'service_request' is a standard fulfillment; 'change' tracks planned modifications; 'p
statusstringCurrent lifecycle state of the ticket. 'pending' means waiting on the submitter or a third party. 'resolved' means a fix has been applied; 'closed' means the su
prioritystringImpact and urgency rating. 'urgent' indicates a critical business impact requiring immediate attention.
categorystringOptional free-form category for grouping and reporting (e.g. 'Hardware', 'Software', 'Network', 'Access').
submitted_by_iduuidUUID of the Person who submitted this ticket.
assigned_to_iduuidUUID of the Person currently assigned to resolve this ticket. Null when unassigned.
team_iduuidUUID of the Group (team) responsible for this ticket. Used for queue-based routing.
sla_policyuuidUUID of the SLAPolicy governing response and resolution time targets for this ticket.
first_response_atdate-timeISO 8601 timestamp of the first agent response. Null until the first response is posted.
resolved_atdate-timeISO 8601 timestamp when the ticket was marked resolved. Null until resolved.
due_atdate-timeISO 8601 deadline for resolution, derived from the SLA policy and creation time. Null if no SLA is applied.
related_asset_iduuidUUID of the PhysicalAsset or CloudResource this ticket relates to. Enables asset-centric helpdesk views.
related_vulnerability_iduuidUUID of a Vulnerability that triggered or relates to this ticket. Links the helpdesk and risk domains.
tagsjsonFree-form tags for filtering and reporting.

API

client.helpdesk.tickets.*
Loading manifest…