Cross-Company Access
Discover how to use a single set of API keys to access multiple companies
Overview
Breezeway Partners or Enterprise Accounts managing multiple companies via the API will receive a single set of API keys that provide access to all associated companies. This is referred to as cross-company access across our documentation.
Company ID & Company Reference ID
To view all companies that you can access, use the List Companies endpoint to access the company_id and the reference_company_id
| Name | Type | Description |
|---|---|---|
| company_id | integer | A unique identifier provided by Breezeway for each company in our system. |
| reference_company_id | string | This value can be set by Breezeway to match company_id (above), or it can be provided by the Partner, to align with their internal systems. |
Determining how reference_company_id will be set per company will be determined during certification.
Using Company Reference ID
For Partners or Enterprise Accounts who manage multiple companies via the API, specifying the company_id is required.
This can be done in two ways, depending on the endpoint and its functionality. Details on which data to use will be provided in the documentation for each endpoint.
Partners & Enterprise Accounts
For questions related to the Breezeway API, please contact us here.
Updated 3 months ago