Skip to main content
Use this read-only API to build operational and financial reports and maintain your own reporting store. Examples use fictional records and placeholder credentials. The production base URL is https://api.getbreezyapp.com/v1. The API uses ordinary REST GET requests and JSON responses.

​
1. Supply your company API key

Set BREEZY_API_KEY in your environment to the key you were issued. Ask your Breezy contact for an API key if you do not have one. Read Authentication before sharing a key with a reporting tool.

​
2. Identify your company and read jobs

A successful request returns HTTP 200. /company returns the company in data, including its timezone; a jobs collection returns data and pagination.

​
3. Continue to the next page

Read the company ID and timezone from /company. Store each job from the page’s data array by its id. To continue, use the returned pagination.next_cursor with the same endpoint and filters; stop when it is null. For example, after assigning the returned token to BREEZY_CURSOR:
Keep already stored pages when a request fails. For a 429, wait the response’s Retry-After seconds and retry the same request. A first collection pass accumulates records; later refreshes can target supported edit/date filters and known IDs. Cursors do not provide a snapshot or a complete change feed.

Build your reporting store

Choose joins and a refresh strategy for your own database.

Choose a business measure

Find the right records and summaries for each report.
Download the OpenAPI specification for the complete reference, or give an agent the documentation index.