Overview
Openbridge offers API access for customers on Premium, Business, and Enterprise plans. Once enabled, you can create refresh tokens to authenticate with the Openbridge API and manage your data pipelines programmatically.
Requirements
An active Premium, Business, or Enterprise subscription
Account owner or admin access
If you are on a Free or Starter plan, you will need to upgrade before API access is available. You can upgrade your plan from the Plans page in the console.
How to Enable API Access
Log in to the Openbridge console at
https://app.openbridge.comNavigate to Account > General
Scroll down to the Enable API Access section
Click the Enable API Access button
Once enabled, you will see a green API Access Enabled badge confirming that API access is active on your account.
Creating a Refresh Token
After enabling API access:
Navigate to API Management > Refresh Token in the console
Follow the steps to generate a new refresh token
Store your token securely — treat it like a password
API Documentation
Full API documentation is available at: https://github.com/openbridge/embedded-api
Frequently Asked Questions
Can I disable API access after enabling it? Contact Openbridge support if you need to revoke API access for your account.
What happens if I downgrade my plan? API access is only available on Premium, Business, and Enterprise plans. If you downgrade to a lower plan, your API access will no longer be available.
Can team members use the API? API access is enabled at the account level. Team members with appropriate permissions can use the API with tokens generated for the account.
