Contacts

List contacts in a segment

Return contacts assigned to a manual segment.

get/v1/segments/{id}/contacts

Request

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

Path parameters

idstring required

The segment ID

Query parameters

limitinteger

Number of contacts to return

pageinteger

Page number for pagination

Response

Contacts in the segment

objectstring required
has_moreboolean required
pageinteger required
page_sizeinteger required
totalinteger required

Contacts in the segment

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"
      }
    }
  ],
  "segment": {
    "id": "seg_product",
    "name": "Product updates"
  },
  "page": 1,
  "page_size": 50,
  "total": 128
}

Changes

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