Skip to content

Get a support ticket diagnostics

Platform module

GET/support-ticket-diagnostics/{id}supportTicketDiagnostics.get

Diagnostics the requester chose to attach to a support request (0643), with the moment they consented. Append-only. Returns one support ticket diagnostics with its `ETag`. A support ticket diagnostics the caller may not see returns 404.

  • Requires the capability me.account.write.
  • OAuth scopes: me.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

supportTicketDiagnostics.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the support ticket diagnostics.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: SupportTicketDiagnostics

supportTicketDiagnostics.get: SupportTicketDiagnostics
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the support ticket diagnostics.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
support_ticket_idstring (uuid)YesIdentifier of the support request.
consented_atstring (date-time)YesWhen the requester agreed to send the diagnostics.
routestring | nullYesPage the requester was on.Constraints: length 1 to 500
app_versionstring | nullYesApp version and build.Constraints: length 1 to 50
devicestring | nullYesBrowser or device and operating system.Constraints: length 1 to 300
recent_errorsstring | nullYesRecent client errors, newest first.Constraints: length 1 to 20000
screenshot_pathstring | nullYesStorage path of a screenshot.Constraints: length 1 to 500
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "support_ticket_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "consented_at": "2026-10-08T14:30:00Z",
  "route": "/demo/credentials/scans",
  "app_version": "4.0.0 (812)",
  "device": "Safari 19 on iOS 26",
  "recent_errors": "TypeError",
  "screenshot_path": "org/ticket/shot.png"
}

Code samples

curl -X GET "$XOS_BASE_URL/support-ticket-diagnostics/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.supportTicketDiagnostics.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.support_ticket_diagnostics.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos support-ticket-diagnostics get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f