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

# Postman Collection

> Use maintained Postman collections for rapid endpoint testing, onboarding, and team-shared request baselines.

# Use Postman for fast request prototyping.

Collections and environment templates are generated from `developer-docs/openapi.yaml` so Postman onboarding stays aligned with published API contracts.

## Download artifacts

<CardGroup cols={2}>
  <Card title="Download collection (hosted in docs repo)" icon="download">
    [Callaro API collection (JSON)](/postman/callaro-api.collection.json)
  </Card>

  <Card title="Import from URL in Postman" icon="play">
    Copy `https://developers.callaro.ai/postman/callaro-api.collection.json` into Postman's **Import** dialog and choose **URL**.
  </Card>

  <Card title="Sandbox environment" icon="flask-conical">
    [Sandbox environment template](/postman/callaro-sandbox.environment.json)
  </Card>

  <Card title="Production environment" icon="server">
    [Production environment template](/postman/callaro-production.environment.json)
  </Card>
</CardGroup>

<Note>
  These artifacts are generated in-repo by `npm run docs:postman`, served from `developers.callaro.ai/postman/*`, and validated by CI with `npm run docs:postman:check`.
</Note>

## Setup workflow

1. In Postman, click **Import** and paste `https://developers.callaro.ai/postman/callaro-api.collection.json` into the **URL** field.
2. Import the sandbox environment from `/postman/callaro-sandbox.environment.json` or production from `/postman/callaro-production.environment.json`.
3. Set `callaroApiKey` and `baseUrl` variables (optional `xTenantId` for scoped requests).
4. Run authentication and health requests first.
5. Execute campaigns, contacts, numbers, and call log folders.
6. Save examples and share workspace with your integration team.

## Team maintenance guidance

* Keep one canonical collection version for each release window.
* Use environment files per sandbox and production.
* Add request examples for common error responses.
* Remove deprecated endpoints from team workspace promptly.
* Regenerate on OpenAPI updates using `npm run docs:postman`.

## Validation checklist

* All critical endpoint folders run without manual header edits.
* Variables are scoped correctly for environment switching.
* Example responses include success and error envelope shapes.