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

# Use the API with an agent

> Give an agent the documentation and a securely configured company key.

An agent can discover the API through the [documentation index](https://developers.getbreezyapp.com/llms.txt), [complete Markdown documentation](https://developers.getbreezyapp.com/llms-full.txt), and [OpenAPI specification](/openapi.json). Individual documentation pages are also available with `.md` appended to their URL. OpenAPI describes exact operations and schemas; the guides explain which business measures to use.

## Configure access

Provide the key through the agent’s secret or environment mechanism, for example `BREEZY_API_KEY`. Give it permission to make read-only HTTPS requests to `https://api.getbreezyapp.com/v1`. Use the [authentication guide](/authentication) for company scope. Avoid pasting credentials into a prompt or documentation search.

## Example task

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
Use the Breezy FSM documentation index and OpenAPI specification.
The company API key is already available as BREEZY_API_KEY.

Build a local report of September 2026 issued invoice activity by
business unit. Read /company first to establish the timezone.
Use the documented invoice-activity summary and follow every cursor.
Explain the statuses, date bounds, amount basis, and missing groups.
Keep the key out of logs and output. Report any unfinished pages.
```

## Check the result

Before relying on the output, check that the agent used the correct company timezone, fetched every page, distinguished cents from dollars, and reported its date and amount basis. For technician results, check [participation overlap and separate sold/earned measures](/technician-performance). For local stores, check [refresh limitations](/reporting-store).

This is a read-only reporting API. Its documentation does not define write endpoints, webhooks, historical snapshots, or a complete change feed.