API tokens

Connect your own systems to the read-only API.

The read-only JSON API lets your developers connect your own systems, such as an ERP or vendor-risk tool, to BordersHub.

  • Under Create a token, give it a name that says what it's for, choose an expiry (at most one year) and select Create token.
  • Copy the token straight away. It's shown only once.
  • Send it as a bearer token. A token can read everything an admin can see, so treat it like a password, and delete it when it's no longer needed.
  • Each token can make 120 requests per minute, and an organization can have up to 25 active tokens.
  • The API Tokens page has code examples and the list of endpoints. The interactive reference is at /api/docs.
  • If your organization's account is suspended, every request gets 401 with the error code organization_suspended. Requests about another company that is suspended get 403 with company_suspended. See Account suspension.