Start hereAuthentication

API authentication

Send your Bual Pro API token using the X-ACCESS-TOKEN request header.

Use this base URL for Bual Pro API requests:

https://app.bualpro.com/api

Required header

The API specification declares header-based API-key authentication:

X-ACCESS-TOKEN: YOUR_BUAL_PRO_API_TOKEN

Enter the token as the header value. The documented scheme does not use a Bearer prefix.

Request format

This example requests the account details endpoint. It shows the request format and has not been executed with an account token.

curl --request GET \
  --url 'https://app.bualpro.com/api/accounts/me' \
  --header 'X-ACCESS-TOKEN: YOUR_BUAL_PRO_API_TOKEN'

Keep your token out of public code, screenshots, shared request URLs, and support posts. Use the authentication field in the playground only when you intend to send a request with that token.

Obtaining and managing tokens

The published Swagger specification does not describe token creation, permission scopes, expiry, rotation, or revocation. Confirm the available token settings with Bual Pro before building an integration that depends on them.

For parameter and response limitations, see Contract notes.