Public beta

Ubuntu BizBox API

Build integrations on top of Ubuntu BizBox. Pull products, push orders, sync customers — straight from the same backend that powers our merchant dashboard.

Get an API key Browse endpoints

API key auth

Bearer tokens with scoped permissions. Shown once at creation — keep them safe.

Predictable JSON

Same response shape across endpoints: { data, total, limit, offset }.

Rate limited

60 requests / minute per key. Usage logged for 30 days, viewable in your dashboard.

Quickstart

Create a key in Dashboard → API keys and pick the scopes you need.
Save the full key (shown once). It looks like ubz_live_abcd1234.eVjK....
Send it in the Authorization header as a bearer token on every request.

curl https://ubuntubizbox.com/api/public/v1/products \
  -H "Authorization: Bearer ubz_live_XXXXXXXX.YYYYYYYYYYYY"

Endpoints

GET

/api/public/v1/products

scope: read:products

List products across all stores owned by the API-key holder.

curl https://ubuntubizbox.com/api/public/v1/products?limit=20 \
  -H "Authorization: Bearer ubz_live_XXXXXXXX.YYYYYYYYYYYY"

GET

/api/public/v1/orders

scope: read:orders

List orders for the API-key holder. Filter by ?status=paid|pending|cancelled.

curl https://ubuntubizbox.com/api/public/v1/orders?status=paid \
  -H "Authorization: Bearer ubz_live_XXXXXXXX.YYYYYYYYYYYY"

Errors

Status	Code	When
401	`unauthorized`	Missing, malformed, or revoked key.
403	`forbidden`	Key is valid but lacks the required scope.
429	`rate_limited`	More than 60 requests in 60 seconds.
500	`server_error`	Something went wrong on our side — retry with backoff.

Need a higher rate limit?

Partners with revenue-share agreements get priority limits and access to write endpoints. Get in touch via the partner program.

Become a partner