Bridge API Documentation

Bridge Documentation

Welcome to our API documentation!

We're happy to share with you our new API 2021 version! Please check our Product Changelog to see the main updates.

You'll find comprehensive guides and documentation to help you start integration Bridge API as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Get Started

API credentials

After creating a sandbox application on the dashboard, you get a set of API credentials (client_id and client_secret). They are the application's credentials and will be used in every API request to authenticate your app.

The client_secret, as its name suggests, should be stored securely in order to make sure that only your servers make calls and trigger action on your app.

Sandbox applications are designed for testing purpose only and are limited to 20 users.

When ready to go in production, please contact us so we can provide production ready credentials.


Please do not use your sandbox credentials in your production environment!

curl "" \
    -X GET \
    -H 'Bridge-Version: 2021-06-01' \
    -H 'Client-Id: MY_CLIENT_ID' \
    -H 'Client-Secret: MY_CLIENT_SECRET'

Updated 6 months ago

API credentials

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.