The Breeze External API provides a secure, rate-limited interface for accessing entity data within your organization. This documentation covers all available endpoints, authentication methods, and example usage.
API keys are used to authenticate and authorize access to the Breeze API.
Visit https://app.breezesec.com/settings/api to manage your organization’s keys.
All API requests require authentication using an API key. API keys must be included in the Authorization header with the Bearer prefix.
Example:
Authorization: Bearer YOUR_API_KEY
All endpoints are rate-limited to 100 requests per minute per API key. Exceeding this limit will result in a 429 Too Many Requests response.
The API uses standard HTTP status codes to indicate the success or failure of requests.
Example Error Response:
{
"detail": "Entity not found"
}