Contacts

List contacts

Return contacts for the current account. Optional query parameters q, status, and limit support filtering.

get/v1/contacts

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/contacts
  • Auth: HTTP bearer

Query parameters

qstring

Search by email, first name, or last name. Several email addresses separated by commas, spaces or new lines are matched exactly, up to 100.

status'all' | 'subscribed' | 'unsubscribed'

Filter by subscription status

disposableboolean

Only contacts on throwaway-mailbox domains (true) or only the rest (false)

segment_idstring

Filter contacts by manual segment

limitinteger

Number of contacts to return

pageinteger

Page number, starting at 1

Response

List of contacts

objectstring required
has_moreboolean required
pageinteger
page_sizeinteger
filtered_totalinteger

Contacts matching the filters

totalinteger

Every contact of the team

subscribedinteger
unsubscribedinteger
disposableinteger

Subscribed contacts on throwaway-mailbox domains

new_7dinteger

Subscribed contacts added in the last 7 days

new_30dinteger

Subscribed contacts added in the last 30 days

contact_limitinteger

The plan's contact limit, with any override for the account

contact_limit_baseinteger

The plan's contact limit without overrides

tierstring

Example response

{
  "object": "list",
  "data": [
    {
      "id": "clx_contact123",
      "email": "steve@example.com",
      "first_name": "Steve",
      "last_name": "Wozniak",
      "segments": [
        {
          "id": "seg_product",
          "name": "Product updates",
          "color": "#10b981"
        }
      ],
      "properties": {
        "company": "Acme"
      },
      "suppression": {
        "id": "clx_suppression123",
        "reason": "hard_bounce",
        "source": "ses",
        "scope": "all"
      }
    }
  ],
  "page": 1,
  "page_size": 50,
  "filtered_total": 1240,
  "total": 1240,
  "subscribed": 1198,
  "unsubscribed": 42,
  "disposable": 3,
  "new_7d": 18,
  "new_30d": 77,
  "contact_limit": 25000,
  "contact_limit_base": 25000,
  "tier": "pro"
}

Changes

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