Contacts

List 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.

get/api/v1/contacts

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/contacts
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: contacts:read)

Query parameters

limitinteger
afterstring

Opaque cursor from a previous response's next_cursor.

searchstring

Case-insensitive substring match on the email address.

subscribed'true' | 'false'

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

Response

Contact list

has_moreboolean required
next_cursorstring nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.