Segments

List segments

GET/segmentsScope contacts:read

Returns your saved segments. A segment is a set of rules (tagged vip and ordered twice, say) that is checked again each time it is used. Build them in the dashboard; the API reads them.

Good to know

approximateContacts is the last count taken, at countedAt. Both are null for a segment nobody has opened yet, which means unknown, not zero. For the current members, use List segment contacts.

Errors

Plus the errors any endpoint can return, such as a missing key or scope. See Errors.

Request

# macOS, Linux or Git Bash, with WAMAFY_API_KEY set. The quoting does not work in Windows cmd or PowerShell.
curl "https://api.wamafy.com/api/v1/public/segments" \
  -H "Authorization: Bearer $WAMAFY_API_KEY"

Response 200

{
  "success": true,
  "data": [
    {
      "id": "0f2c8a1e-6b3d-4c9a-8e2f-5d7b1a3c9e40",
      "name": "VIP buyers",
      "description": "Tagged vip, ordered at least twice",
      "conditions": 2,
      "approximateContacts": 128,
      "countedAt": "2026-10-07T06:00:00.000Z",
      "createdAt": "2026-09-20T10:00:00.000Z"
    }
  ]
}

Base URL https://api.wamafy.com/api/v1/public