Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get the account's claim status

BillionSend extension. Whether the account behind the key is still unclaimed, when it deletes itself, and what it may do meanwhile. Any key may ask; an account a person has claimed answers claimed with no limits.

GET/agent/status
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Responses
200

The account's status

objectstringrequired
Allowed:agent_account
statusstringrequired
Allowed:unclaimedclaimed
claimobject | nullrequired

Set while the account is unclaimed

Show properties
expires_atstringrequired
mails_leftintegerrequired

How many more times the claim link can be sent again

limitsobject | nullrequired

Set while the account is unclaimed

Show properties
receive_onlybooleanrequired
inboxesintegerrequired
emails_per_dayintegerrequired
received_per_dayintegerrequired

Emails the account may receive per UTC day; past it the sender is told to retry

received_per_inbox_per_hourintegerrequired

Emails the inbox may receive per rolling hour; past it the sender is told to retry

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Request
curl -X GET 'https://api.billionsend.com/agent/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "agent_account",
  "status": "unclaimed",
  "claim": {
    "expires_at": "string",
    "mails_left": 0
  },
  "limits": {
    "receive_only": true,
    "inboxes": 0,
    "emails_per_day": 0,
    "received_per_day": 0,
    "received_per_inbox_per_hour": 0
  }
}

Was this page helpful?