Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List emails

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.

GET/emails
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

Emails

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
idstring<uuid>required
fromstringrequired
tostring[]required
ccstring[] | nullrequired
bccstring[] | nullrequired
reply_tostring[] | nullrequired
subjectstringrequired
created_atstringrequired
scheduled_atstring | nullrequired
last_eventstringrequired
has_morebooleanrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted 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/emails' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "from": "string",
      "to": [
        "string"
      ],
      "cc": [
        "string"
      ],
      "bcc": [
        "string"
      ],
      "reply_to": [
        "string"
      ],
      "subject": "string",
      "created_at": "string",
      "scheduled_at": "string",
      "last_event": "string"
    }
  ],
  "has_more": true
}

Was this page helpful?