Flexport is connected once at the org level by an admin. The credential is shared across all groups that have been granted access — individual team members don't need to connect their own accounts.
Go to Flexport → Settings → API
Create a new API token with the required permissions
Copy the token and paste it below
Ready to connect?
Go directly to the integrations page in your dashboard.
These are the data scopes On Belay can be granted for Flexport. Your org admin controls which scopes are enabled per group.
| Scope | Description | Access |
|---|---|---|
shipments:read | Read shipments | Read only |
shipments:write | Write shipments | Read / Write |
bookings:read | Read bookings | Read only |
documents:read | Read trade documents | Read only |
analytics:read | Read analytics & reporting | Read only |
Double-check that you copied the full key without any leading/trailing spaces. Some platforms show a truncated preview — make sure to copy the full token. If the key was generated with restricted scopes, verify it includes the permissions listed above.
Check that your group has been granted access to this integration in On Belay → Groups → [your group] → Integrations. Also verify the specific scopes your group is permitted to use match what your query requires.
Some API keys have expiration policies. Generate a new key in Flexport and update it in On Belay → Integrations → Flexport → Update key. Consider creating a dedicated service account or machine user for On Belay so the key isn't tied to a personal account.
Still stuck? We're happy to help.
Contact support →