How do I request my Breadcrumb API?

The Breadcrumb API lets your own systems pull data out of Breadcrumb, most often to build reports in a tool like Microsoft Power BI. To use it, you need your company's API key and the API documentation.

Your API key works like a password for your company's data. Anyone who has it can copy information from your Breadcrumb account, including workers' personal details collected through inductions and forms. Because of that, we issue keys by request only and run some checks before we send one.

Who can request an API key

The request must come from someone who works at the company that holds the Breadcrumb account. Ideally that's your main Breadcrumb contact, or someone they've introduced to us in writing.

We can only send API keys to you, our customer. If a software provider or integration partner needs access to your data, request the key yourself and decide whether to share it with them.

What to include in your request

Have these details ready:

• Your company name, exactly as it appears in Breadcrumb. Copy and paste it if you can. We check it closely so a key is never issued for the wrong company.
• The Company Host the key will be tied to. Give us their name and mobile number. The API key uses this person's permissions, so it can only reach the data they can see in Breadcrumb.
• What you'll use it for. For example, reporting in Power BI.
• The level of access you need. Tell us if you only need certain data, such as sites, companies or reports, or if you need full access.

How to request your API key

1. Send your request in writing to your Customer Success Manager (CSM) or the Breadcrumb support team, with the details above.
2. We'll confirm your request with you. We may call you, and we'll check that the request has come from your company.
3. Once everything checks out, we'll email you a secure link to your API key, along with a link to the API documentation.
4. Open the link and copy the key into a secure location, such as your company's password manager.

The secure link expires on the date shown in the email. If it expires before you've copied the key, contact your CSM.

Keeping your API key safe

• Store it somewhere secure. Don't paste it into emails, chat messages or shared documents.
• Only share it with people who need it. Once your key is shared, Breadcrumb can't control who uses it or what they do with your data. That includes any copies of licences, addresses or other personal information you collect in Breadcrumb.
• Use it for the purpose you requested it for.
• Tell us straight away if you think it's been exposed. Contact your CSM as soon as you notice.