Contacts

List contacts

get/contacts

Request

  • Base URL: https://api.supersendtx.com
  • URL: https://api.supersendtx.com/contacts
  • Auth: HTTP bearer

Query parameters

limitinteger
cursorstring
searchstring

Matches email, first name, last name, or external id

emailstring email

Exact match on the contact's email address (case-insensitive). Returns at most one contact, or an empty data array when none matches. A blank value returns 400.

status'subscribed' | 'unsubscribed' | 'bounced' | 'complained'

Derived on read. A contact who is suppressed, or who has opted out of newsletter mail, always reads back as unsubscribed — there is one source of truth for consent and this reflects it.

list_idstring

Only contacts belonging to this list

Response

Contact list

has_moreboolean required
next_cursorstring nullable required

Changes

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