Contacts

Export contacts

Export up to 10,000 contacts for the current account as CSV or JSON. Optional status and disposable filtering match the list endpoint.

get/v1/contacts/export

Request

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

Query parameters

format'csv' | 'json'

Export format

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

Filter by subscription status

disposableboolean

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

Response

Contacts export

objectstring required
has_moreboolean required

True when more than 10,000 contacts matched and the export stopped there

exported_atstring date-time required

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"
      }
    }
  ]
}

Changes

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