Does Breadcrumb have an open API?

Yes. Breadcrumb has an open REST API that lets your own systems work with the data in your Breadcrumb account. Most customers use it to pull data into reporting tools like Microsoft Power BI, or to connect Breadcrumb to other systems they run.

Access is by request. Each customer gets their own API key, and we send it along with the API documentation once your request has been checked.

Who the API is for

The API is for Breadcrumb customers. It's built for people with some technical know-how, such as:

• Reporting and data teams who want Breadcrumb data in their own dashboards and reports.
• IT teams and developers connecting Breadcrumb to internal systems.
• Software providers you work with, using an API key you've requested and chosen to share with them.

You don't need the API to use Breadcrumb's built-in integrations, such as Procore and Autodesk. Those are set up with your Customer Success Manager (CSM).

What's available

The API covers the core records in your Breadcrumb account, including:

• Sites: the sites your API key can access.
• Suppliers: the companies on each site.
• Workers: the workers on each site, including adding or updating workers from another system.
• Reports: report data you can pull into your own tools. Large reports are returned in pages.

The API documentation lists every available endpoint, with the fields each one returns and accepts. If the data you need isn't there, let your CSM know what you're trying to do.

How access works

• One key per company. Your API key only works with your company's Breadcrumb account.
• The key follows a Company Host's permissions. When you request a key, you tell us which Company Host it's tied to. The key can only reach the sites and data that person can see.
• Your data stays in your region. Australian and New Zealand accounts use Breadcrumb's Australian server, and the documentation we send matches it.
• Keys are issued by request. There's no self-serve sign-up. We check every request before issuing a key, because the key gives access to workers' personal information.

Getting started

1. Work out what you want to do with the API and who on your team will build it.
2. Request your API key. See Request an API key for your Breadcrumb account for what to include.
3. Once you receive your key and the API documentation, store the key somewhere secure and share the documentation with your developer.

Treat your API key like a password. Anyone who has it can access your company's data, so only share it with people and providers you trust.