Skip to Content
SendlySendly
API ReferenceKeyless

Get a keyless start's status

GET
/api/v1/keyless

Where a keyless start stands: the address, whether it is confirmed, the free test emails left, and the claim link. Bearer: the keyless key.

Requires the emails:test scope — Send test emails to your own address from the Sendly sandbox.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

Response Body

Keyless start status

application/json
  1. response

Where a keyless start stands.

email*string

The start's address.

Formatemail
verified*boolean

Whether the address is confirmed.

claimed*boolean

Whether a person claimed the project. Always false here: a claim revokes this key.

code_email*|

The mail carrying the current code. Null once the address is confirmed, or when there is no mail to read.

test_allowance*

Where the project stands against its free test emails.

claim_url*string

Where a person claims this test project into a free account. The key rides in the URL fragment, which a browser never sends to a server.

Formaturi
Example Request
curl -X GET 'https://api.sendly.now/api/v1/keyless'
Example Response
{  "email": "user@example.com",  "verified": true,  "claimed": true,  "code_email": {    "status": "queued",    "reason": "string",    "say": "string"  },  "test_allowance": {    "limit": 0,    "used": 0,    "remaining": 0  },  "claim_url": "http://example.com"}