Skip to Content
SendlySendly
API ReferenceContacts

Get a one-time link the user opens to download this project's contacts as CSV

GET
/api/contacts/export

Get a one-time link the user opens to download this project's contacts as CSV. Filters: search (part of an email address), subscribed (true or false).

Requires the contacts:read scope — View your contacts and their custom fields.

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

OK

application/json
  1. response

An agent's answer: a one-time link that downloads the CSV. A dashboard session receives the CSV itself.

status*"action_required"
Value in"action_required"
url*string

A single-use /go/ link; it works once, for 15 minutes, signed in.

expires_in*integer
what*string
instruction*string
Example Request
curl -X GET 'https://api.sendly.now/api/contacts/export'
Example Response
{  "status": "action_required",  "url": "string",  "expires_in": 0,  "what": "string",  "instruction": "string"}