Contract Management

List insurance contracts

Lists insurance contract summaries owned by the authenticated organization with optional filters for payer configuration, facility, active status, and base reimbursement type.

GETNeeds publication reviewExternal or credentialedContract ManagementoperationId: listContractManagementContractshttps://dev-api.quickintell.com/api/v1/contract-management/contracts

Needs publication reviewExternal or credentialedRevenue integrity

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 and E7 credential, webhook, and vendor trust 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

External or credentialed

May touch credentials, webhooks, SFTP, EHRs, payers, portals, clearinghouses, or other external systems.

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 revenue integrity contract generated for GET /api/v1/contract-management/contracts. 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/contract-management/contracts, 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	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
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.
External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence 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.

Contract Management public API.

Contract Management APIs expose organization-scoped insurance contract inventory and local revenue-integrity workflow controls for contract list, detail, create, and update operations; what-if rate simulation drafts; fee schedule validation/import; underpayment detection; dispute-letter request recording; assignment; and resolution. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector. Every referenced payer configuration, facility, contract, claim, underpayment case, assignee, fee schedule, rate schedule, simulation, activity, and audit row must resolve inside the authenticated organization. These endpoints manage QuickRCM local state and audit evidence. They do not call payer systems, prove payer acceptance, upload or return contract files, generate or transmit live dispute letters, post cash, adjudicate claims, update Electronic Health Record (EHR) billing resources, or guarantee external recovery. Use synthetic examples and keep names, notes, rate-change context, dispute text, and import data free of real protected health information (PHI), credentials, tokens, raw Electronic Data Interchange (EDI), payer portal payloads, S3 keys, and vendor responses.

What this endpoint does

Use case

Use this endpoint to populate contract inventory views, reconcile payer/facility contract coverage, find active or inactive contract records, or locate a contract before requesting detail.

Before calling

Authenticate with a tenant-scoped API key that has `contract-management:read` or `contract-management:write`. Decide the narrowest available payer, facility, active-state, or base-rate-type filter and use bounded pagination. The implementation rate-limits Contract Management public API calls to 60 requests per 60 seconds.

Request and response behavior

Request guidance

`page` is one-based and defaults to 1. `pageSize` defaults to 25 and is capped at 100. `isActive` is a string query value and must be `true` or `false` when supplied. `baseRateType` must be one of the Contract Management rate type enum values. `payerConfigId` and `facilityId` are QuickRCM tenant-scoped identifiers, not external tenant selectors.

Do not send `organizationId`; the API key selects the tenant.
`isActive` is not a boolean query value in the OpenAPI contract; send the string `true` or `false`.
Use `payerConfigId` and `facilityId` only after resolving those identifiers from the same tenant.

Response semantics

The response returns local QuickRCM contract summaries plus pagination metadata. Summary rows include contract identifiers, payer/facility summaries, effective and termination dates, active flag, base reimbursement type, decimal monetary strings, and a rate schedule count. `total` is the total count matching the filters, `pageSize` is the effective page size, and `totalPages` is computed from `total` and `pageSize`. The list response does not include the active rate schedule rows themselves.

`data.contracts` is local contract inventory, not payer confirmation or contract-file evidence.
Monetary response fields such as `baseRate` and `medicarePercent` are decimal strings or null.
`payer.id` is the QuickRCM payer configuration id; `payer.payerId` is the optional external payer identifier stored on that payer configuration.
Use getContractManagementContract for the active rate schedule rows associated with one contract.

Errors and retries

Treat 400 as invalid query or pagination input, 401 as missing or invalid bearer credentials, 403 as insufficient scope or tenant authorization failure, and 429 as a backoff signal. Retry only transient 5xx responses with normal client retry limits.

400 can indicate invalid `page`, `pageSize`, `isActive`, or `baseRateType` values.
403 means the authenticated context cannot access the requested organization scope.
429 should be retried with backoff rather than tight polling.

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

Name	Location	Required	Type	Description	Validation and safety notes
page	query	No	integer	One-based page number for contract list pagination. Defaults to 1.	Minimum value: 1. Default: 1.
pageSize	query	No	integer	Maximum number of contracts to return. Defaults to 25 and cannot exceed 100. The response echoes the effective page size.	Minimum value: 1. Maximum value: 100. Default: 25.
payerConfigId	query	No	string	Optional QuickRCM payer configuration identifier. It must belong to the authenticated organization and is not the same field as `payer.payerId`.	Minimum length: 1.
facilityId	query	No	string	Optional QuickRCM facility identifier. It must belong to the authenticated organization.	Minimum length: 1.
isActive	query	No	true \| false	Optional active-state filter. The public query schema accepts only the strings `true` and `false`.	Enum values are declared in the Type column.
baseRateType	query	No	FEE_SCHEDULE \| PER_DIEM \| DRG_BASED \| CASE_RATE \| PERCENT_OF_CHARGE \| MEDICARE_PERCENT \| CAPITATED \| STOP_LOSS \| OUTLIER \| CARVE_OUT	Optional base reimbursement type filter, such as `FEE_SCHEDULE`, `PER_DIEM`, `DRG_BASED`, `CASE_RATE`, `PERCENT_OF_CHARGE`, `MEDICARE_PERCENT`, `CAPITATED`, `STOP_LOSS`, `OUTLIER`, or `CARVE_OUT`.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-only.

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

Insurance contracts for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "contracts": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "payerConfigId": "00000000-0000-4000-8000-000000000001",
        "facilityId": "00000000-0000-4000-8000-000000000001",
        "contractName": "Example contract_management_contract",
        "contractNumber": "example-contractnumber",
        "effectiveDate": "2026-06-08T10:15:30Z",
        "terminationDate": "2026-06-08T10:15:30Z",
        "isActive": true,
        "baseRateType": "FEE_SCHEDULE",
        "baseRate": "example-baserate",
        "medicarePercent": "example-medicarepercent",
        "payer": {
          "id": "00000000-0000-4000-8000-000000000001",
          "payerName": "Example contract_management_contract",
          "payerId": "87726"
        },
        "facility": {
          "id": "00000000-0000-4000-8000-000000000001",
          "name": "Example contract_management_contract",
          "state": "example-state"
        },
        "rateSchedulesCount": 1,
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "2026-06-08T10:15:30Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

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 parameters.