Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de consulta
limitinteger

Page size, 1-100 (default 20)

mín. 1 · máx. 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.

Respuestas
200

Emails

objectstringobligatorio
Valores permitidos:list
dataobject[]obligatorio
Mostrar propiedades
Array de object
idstring<uuid>obligatorio
fromstringobligatorio
tostring[]obligatorio
ccstring[] | nullobligatorio
bccstring[] | nullobligatorio
reply_tostring[] | nullobligatorio
subjectstringobligatorio
created_atstringobligatorio
scheduled_atstring | nullobligatorio
last_eventstringobligatorio
has_morebooleanobligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X GET 'https://api.billionsend.com/emails' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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
}

¿Te ha resultado útil esta página?