Contacts

Retrieve a contact

Retrieve a contact by ID or URL-encoded email address.

get/v1/contacts/{id}

Request

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

Path parameters

idstring required

The contact ID or URL-encoded email address

Response

Contact details

idstring required
emailstring email required
first_namestring nullable
last_namestring nullable
created_atstring date-time required
unsubscribedboolean required
disposableboolean required

The address is on a known throwaway-mailbox domain (set when the contact is created).

suppressedboolean required

The address is on the suppression list

objectstring
propertiesobject

Example response

{
  "id": "clx_contact123",
  "email": "steve@example.com",
  "first_name": "Steve",
  "last_name": "Wozniak",
  "segments": [
    {
      "id": "seg_product",
      "name": "Product updates",
      "color": "#10b981"
    }
  ],
  "object": "contact",
  "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.