Support

List support tickets

Returns local Support ticket snapshots for the bearer-key organization and the synthetic public API actor selected by current public API authentication behavior.

GETNeeds publication reviewCommunicationSupportoperationId: listSupportTicketshttps://dev-api.quickintell.com/api/v1/support/tickets

Needs publication reviewCommunicationSupport

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use. Also requires E2 side-effect policy before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Communication

May imply email, SMS, fax, phone, notices, support messages, or delivery workflow behavior.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the support contract generated for GET /api/v1/support/tickets. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for GET /api/v1/support/tickets, but keeps the route out of ordinary production API positioning until review is complete.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior.

Not public from this page

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	Read request; no mutation idempotency contract needed.	Use ordinary safe-read retry behavior with rate-limit backoff.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Support public API.

Support public API endpoints create and read local QuickRCM support tickets for the organization selected by the bearer API key. The current public surface has three operations: create a ticket, list tickets visible to the public API actor, and retrieve one visible ticket by `ticketId`. In these docs, `public API actor` should be defined precisely and framed as current implementation behavior, not a permanent identifier contract. user` from an active organization member, and the Support operations verify that member and filter ticket reads by both `organizationId` and that synthetic `userId`. Current actor resolution prefers the earliest active owner member for the organization, falling back to the earliest active member when no owner exists. The actor is not an all-organization support queue and is not a separate ticket namespace for each API key. Public callers should not send `organizationId`, `userId`, status, resolution, assignment, comment, attachment, screenshot, or admin queue fields. The API key selects the organization and the implementation supplies the actor. Ticket `subject`, `description`, `pageUrl`, and `userAgent` are persisted and may be included in support notification email, so examples and guidance must avoid PHI, credentials, tokens, raw EDI, transcripts, S3 keys, payer portal credentials, raw EHR/FHIR responses, and vendor payloads. `pageUrl` is optional string context with a 2000-character cap and nullable storage. The contract does not validate URL syntax, so documentation should describe it as caller-supplied page context and recommend stripping patient-identifying query strings, signed URLs, access tokens, and external portal session details before submission. These endpoints manage local SupportTicket records only. They do not expose comment threads, attachments, ticket updates, lifecycle transitions, SLA controls, admin queues, auto-ticketing from upstream modules, EHR reads/writes, payer actions, or guaranteed email delivery.

What this endpoint does

Use case

Use this endpoint to reconcile recently filed Support tickets or display the current actor's visible ticket history in an external support workflow.

Before calling

Authenticate with a tenant-scoped bearer API key. This read endpoint accepts `support:read` or `support:write`; the shared auth helper also accepts `support:*`, `public-api:*`, or `*` through wildcard matching.

Request and response behavior

Request guidance

The OpenAPI operation defines no request body, path parameters, or query parameters. Do not document pagination, search, status filters, `organizationId`, `userId`, or all-organization list behavior for this endpoint.

No request body is accepted.
No path or query parameters are part of the documented public contract.
`organizationId` is derived from authentication context and should not be documented as a tenant selector.
Use returned opaque `id` values as `ticketId` path parameters for getSupportTicket.

Response semantics

A 200 response returns `success: true` and `data.tickets`. Current operation behavior orders visible tickets by `createdAt` descending and returns at most 100 records. Each row is a local QuickRCM SupportTicket snapshot for the resolved actor and organization, not an external help desk record, all-organization queue, or SLA commitment.

`data.tickets[]` contains only tickets visible to the synthetic public API actor in the authenticated organization.
The response does not represent all Support tickets in the organization.
`subject` and `description` are persisted caller-entered ticket text and can be sensitive if submitted incorrectly; clients should not echo them into logs, analytics, traces, or downstream tools without redaction.
Resolution fields can be null for open or unresolved tickets.
Comments, attachments, assignment data, SLA targets, notification delivery state, and admin-only queue fields are not returned.

Errors and retries

Treat 401 as missing or invalid authentication, 403 as missing accepted Support scope or missing actor membership, 429 as API-key rate limiting, and 500 as a transient server-side failure. Back off on 429 and avoid tight polling loops.

400 is declared in the OpenAPI contract as a standard invalid request response, although the current list schema defines no accepted query fields.
401 and 403 require credential, scope, or membership correction before retrying.
After a 500, retry cautiously and compare returned `id` values before assuming a ticket is missing.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

This endpoint does not define path parameters.

Query parameters

This endpoint does not define query parameters.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

This endpoint does not define a JSON request body.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

No request example is declared.

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

200

Support tickets for the authenticated organization

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "tickets": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "category": "STC_BUG",
        "priority": "STP_LOW",
        "status": "ST_OPEN",
        "subject": "example-subject",
        "description": "Example support_ticket note",
        "pageUrl": "https://example.quickintell.com/resource",
        "userAgent": "example-useragent",
        "resolvedAt": "2026-06-08T10:15:30Z",
        "resolutionNotes": "Example support_ticket note",
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "2026-06-08T10:15:30Z"
      }
    ]
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request