Quickstart

Follow this path to make your first tenant-scoped QuickRCM public API request and understand where to find the exact schema for each module endpoint.

1

Get a public API key for one tenant

Create or request a QuickRCM public API key for your integration. The key determines tenant context and the scopes available to the request.

2

Send only workflow fields, not tenant selectors

Public request bodies should contain the workflow fields shown in the generated reference, such as patient, payer, claim, denial, or payment details. organizationId is not a public tenant selector.

3

Check route status before choosing an endpoint

Endpoint pages now show whether a route is baseline-reference, compatibility-limited, or needs publication review. Do not use compatibility routes or routes needing publication review as happy-path examples.

4

Use the generated reference for exact schema

Use the generated API reference for the exact method, path, request schema, response schema, status codes, and operation ID. Public API paths usually use the /api/v1 prefix.

5

Handle validation, authorization, rate limit, and async outcomes

Treat 400, 401, 403, 404, 409, 429, and 202 as normal integration outcomes. Queueing, dry-run, simulation, and local writes are not proof of live external execution.

First request status

The docs intentionally do not publish a universal happy-path first request yet. Pick only a route whose endpoint page shows baseline-reference status, read the side-effect label, and avoid compatibility-limited routes or routes needing publication review for onboarding examples.

Base request pattern

curl -X GET "https://dev-api.quickintell.com/api/v1/<classified-read-endpoint>" \
  -H "Authorization: Bearer <QUICKRCM_API_KEY>" \
  -H "Content-Type: application/json"

Use the generated reference for exact payloads

This guide explains integration concepts. The generated reference is the source of truth for methods, paths, required fields, schemas, status codes, and operation IDs.

Open API reference