> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API tools

> OpenAPI spec, Postman collection, and generated clients

Everything here is generated from the same contract, so the spec, the Postman
collection, and any client you generate stay in step with the API reference.

## OpenAPI spec

The full OpenAPI 3.1 contract is published at
[`/openapi.yaml`](/openapi.yaml). It is also listed in
[`llms.txt`](/llms.txt) for agents and indexing tools.

Auth is HTTP Bearer (`BearerAuth`) on every operation, and the API reference
playground already reads the per-operation `security` block.

## Postman collection

<a href="/postman/Scan.com-API-v2.postman_collection.json" download="Scan.com-API-v2.postman_collection.json" className="no-underline">
  <Card title="Download the Postman collection" icon="download">
    Collection v2.1 — 16 folders, 41 requests, bearer auth preconfigured
  </Card>
</a>

To import it, open Postman and choose **File → Import**, then drop in the
downloaded file. The collection sets bearer auth once at the collection level,
so every request inherits it.

Set two collection variables under **Variables** before your first call:

| Variable      | Set it to                                                                                                         |
| ------------- | ----------------------------------------------------------------------------------------------------------------- |
| `baseUrl`     | `https://api.staging.scan.com` for sandbox, `https://api.scan.com` for production. Sandbox is the shipped default |
| `bearerToken` | Your `api_token` from [Get API keys](https://admin.staging.scan.com/partner/api_access). Ships empty              |

Start with the **Testing** folder to bootstrap fixtures, then **Referrals** to
create your first case. [Quickstart](/guides/quickstart) walks the same sequence
in cURL.

You can also import `/openapi.yaml` directly into Postman instead of using the
collection, but you will not get the folder grouping or the preset variables.

## Generated clients

Scan does not publish npm or PyPI packages today. Generate a client from the
spec with openapi-generator, or an equivalent, and pin it to a spec version you
have tested against. See [API versioning](/guides/api-versioning) for what can
change without notice.