Skip to Content
SendlySendly
API ReferenceContacts

List contacts

GET
/api/v1/contacts

Cursor-paginated list of contacts, newest first. Pass the previous response's next_cursor as after to page forward; has_more is false and next_cursor is null on the last page.

A cursor is bound to the filters that minted it. Changing search or subscribed while reusing a cursor answers 422 validation_error rather than returning a page that belongs to neither query — drop the cursor and start again from the first page.

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.

limit?integer
Range1 <= value <= 100
Default20
after?string

Opaque cursor from a previous response's next_cursor.

Length1 <= length
search?string

Case-insensitive substring match on the email address.

Length1 <= length
subscribed?string

Filter to subscribed (true) or unsubscribed (false) contacts. Omit for both.

Value in"true""false"

Response Body

Contact list

application/json
  1. response

Cursor-paginated list of contacts.

data*array<>
has_more*boolean
next_cursor*|

Pass as after to fetch the next page. null on the last page.

Example Request
curl -X GET 'https://api.sendly.now/api/v1/contacts'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string",      "subscribed": true,      "custom_fields": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}