API Reference

Introduction

The Bread Crumbs APIs have two types:

  • APIs follow the principles of Representational State Transfer (REST) protocol
  • APIs follow the GraphQL protocol over HTTP protocol

One of the key features of the Bread Crumbs APIs is its support for backwards compatibility, which ensures that any changes made to the API are always backwards compatible. This means that clients using previous versions of the API will not be affected by the updates.

By leveraging the Bread Crumbs APIs, developers can easily integrate Bread Crumbs's functionality into their applications, allowing them to enhance their users' experience and increase the efficiency of their workflows.

Authentication

Bread Crumbs APIs uses token to allow access to the APIs. You will receive token after a successful login request to the dashboard. Alternatively, you can register a new Bread Crumbs API key at our API keys (opens in a new tab) page.

Bread Crumbs APIs expects for the token to be included in all API requests to the server in a header that looks like the following:

Authorization: <TOKEN>
ℹ️

You can create your API Keys on your API keys (opens in a new tab) page.