Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

List domains

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. The team’s subdomain of the shared domain, when it has one, is the last row (shared: true).

GET/domains
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Query-Parameter
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.

Antworten
200

Domains

objectstringerforderlich
Erlaubt:list
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
namestringerforderlich
statusstringerforderlich
created_atstringerforderlich
regionstringerforderlich
open_trackingbooleanerforderlich
click_trackingbooleanerforderlich
tracking_subdomainstring | nullerforderlich
tracking_statusstring | nullerforderlich

BillionSend extension: where the tracking subdomain stands: pending (waiting for its CNAME and certificate), active (links go through it) or failed (did not activate within 72 hours; links use the shared host). null while no tracking_subdomain is set.

Erlaubt:pendingactivefailednull
tracking_errorstring | nullerforderlich

BillionSend extension: why the tracking subdomain is not active, when known

unsubscribe_subdomainstring | nullerforderlich

BillionSend extension: the domain's own unsubscribe host label, null when unset

unsubscribe_statusstring | nullerforderlich

BillionSend extension: where the unsubscribe subdomain stands: pending, active (unsubscribe links go through it) or failed (links use the shared host). null while no unsubscribe_subdomain is set. When both subdomains are the same label they share one host and always read the same.

Erlaubt:pendingactivefailednull
unsubscribe_errorstring | nullerforderlich

BillionSend extension: why the unsubscribe subdomain is not active, when known

unsubscribe_pageobjecterforderlich

BillionSend extension: this domain's own look for its unsubscribe pages. A null field falls back to the team's default page, then to the built-in default.

Eigenschaften anzeigen
brand_namestring | nullerforderlich
messagestring | nullerforderlich
success_messagestring | nullerforderlich
redirect_urlstring | nullerforderlich
background_colorstring | nullerforderlich
text_colorstring | nullerforderlich
accent_colorstring | nullerforderlich
logo_radiusstring | nullerforderlich
Erlaubt:squaregentleroundedcirclenull
logo_urlstring | nullerforderlich

Read-only; uploaded in the dashboard

capabilitiesobjecterforderlich
Eigenschaften anzeigen
sendingstringerforderlich

enabled; on the shared row, disabled while sending from the shared domain is paused

receivingstringerforderlich

enabled while the domain receives mail

receiving_catch_allbooleanerforderlich

BillionSend extension: whether mail to an address without an inbox is stored (true) or refused at RCPT (false)

sharedbooleanerforderlich

BillionSend extension: true on the team's subdomain of the shared inbox domain, a read-only row listed after the team's own domains (403 on changes) that POST /inboxes domain_id takes; false on the team's own domains

sending_modestring

BillionSend extension, on the shared row only: what its inboxes' addresses may send. open starts conversations, reply_only replies inside their threads, receive_only sends nothing. Holds on names still apply per send: an address whose username or from_name imitates a brand, or one on an older label that does, replies only, even when the mode is open.

Erlaubt:openreply_onlyreceive_only
sending_mode_reasonstring | null

BillionSend extension, on the shared row only: what holds sending below open: plan when the team's plan holds it, the other value when the platform's sending switches do; null when open

Erlaubt:planinstancenull
has_morebooleanerforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/domains' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "status": "string",
      "created_at": "string",
      "region": "string",
      "open_tracking": true,
      "click_tracking": true,
      "tracking_subdomain": "string",
      "tracking_status": "pending",
      "tracking_error": "string",
      "unsubscribe_subdomain": "string",
      "unsubscribe_status": "pending",
      "unsubscribe_error": "string",
      "unsubscribe_page": {
        "brand_name": "string",
        "message": "string",
        "success_message": "string",
        "redirect_url": "string",
        "background_color": "string",
        "text_color": "string",
        "accent_color": "string",
        "logo_radius": "square",
        "logo_url": "string"
      },
      "capabilities": {
        "sending": "string",
        "receiving": "string"
      },
      "receiving_catch_all": true,
      "shared": true,
      "sending_mode": "open",
      "sending_mode_reason": "plan"
    }
  ],
  "has_more": true
}

War diese Seite hilfreich?