Your restricted-goods rules | border.bot API docs

GET https://api.border.bot/v1/restrictions/rules

Requires an API key (Authorization: Bearer bb_live_…).

Rules your restricted-goods checks apply on top of border.bot’s (a compliance team’s own list). Free.

API key scope: settings.

Responses#

200: Your rules. (RestrictionRulesResponse)
401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
403: The API key doesn’t have the settings scope (forbidden, details.reason: "missing_scope"). (Error)
429: Rate limited (rate_limited). Retry after Retry-After seconds; RateLimit says which limit was hit (r=0, t seconds until its window ends) and RateLimit-Policy its quota. (Error)
500: Unexpected error (internal). (Error)

bash

curl -X GET 'https://api.border.bot/v1/restrictions/rules' \
  -H 'Authorization: Bearer bb_live_...'