Contacts

List segments

Return manual contact segments for the current account.

get/v1/segments

Request

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

Response

List of segments

objectstring required
has_moreboolean required

Always false: every segment is in one page

totalinteger required
segment_limitinteger required
tierstring

Example response

{
  "object": "list",
  "data": [
    {
      "id": "clx_segment123",
      "name": "Customers",
      "color": "#10b981",
      "contact_count": 42
    }
  ],
  "total": 2,
  "segment_limit": 10,
  "tier": "starter"
}

Changes

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