Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List API keys

Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones. A key held to one domain lists only the keys held to that same domain.

GET/api-keys
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
limitinteger

Page size, 1-100 (default 20)

min 1 · max 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

Responses
200

API keys (never tokens)

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
idstring<uuid>required
namestringrequired
created_atstringrequired
last_used_atstring | nullrequired
inbox_idstring<uuid> | nullrequired

BillionSend extension: the one inbox the key is restricted to, or null

has_morebooleanrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/api-keys' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "created_at": "string",
      "last_used_at": "string",
      "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2"
    }
  ],
  "has_more": true
}

Was this page helpful?