border.bot
Docs menu

API reference

API reference

Your bulk runs

GET https://api.border.bot/v1/bulk/runs

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

Your workspace’s bulk runs, newest first.

API key scope: bulk.

Parameters#

Name Type Required Description
limit integer no

Responses#

  • 200: The runs. (BulkRunsResponse)
  • 400: Invalid input (invalid_input). (Error)
  • 401: Missing, invalid, revoked or expired API key (unauthorized). (Error)
  • 403: The API key doesn’t have the bulk 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)

Example#

bash
curl -X GET 'https://api.border.bot/v1/bulk/runs' \
  -H 'Authorization: Bearer bb_live_...'