API ReferenceContacts
List contacts
GET
Cursor-paginated list of contacts. Supports filter by search and subscribed.
Requires the contacts:read scope — View your contacts and their custom fields.
header
AuthorizationBearer <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?integerRange
1 <= value <= 100Default
50cursor?stringsearch?stringsubscribed?stringValue in
"true""false"Contact list
application/json- response
Cursor-paginated list of contacts.
success*trueValue in
truedata*curl -X GET 'https://api.sendly.now/api/contacts'Example Response
{ "success": true, "data": { "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "email": "user@example.com", "subscribed": true, "customFields": { "property1": null, "property2": null }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "total": 0, "nextCursor": "string", "hasMore": true }}