sendsend.email
Sign inStart building

List segments

GET/v1/segments

All segments in the project, or those of one audience.

Required scope: contacts:manage

Parameters

NameInDescription
audience_idoptionalqueryOnly segments of this audience.

Example

curl -X GET 'https://api.sendsend.email/v1/segments' \
  -H "Authorization: Bearer $SENDSEND_API_KEY"

Response 200

{
  "object": "list",
  "data": [
    {
      "id": "seg_Pm4…",
      "object": "segment",
      "audience_id": "aud_7Qe2…",
      "name": "Pro customers",
      "match": "all",
      "rules": [
        {
          "field": "property",
          "key": "plan",
          "op": "equals",
          "value": "pro"
        },
        {
          "field": "status",
          "op": "is",
          "value": "subscribed"
        }
      ],
      "created_at": "2026-10-06T15:00:00.000Z",
      "updated_at": "2026-10-06T15:00:00.000Z"
    }
  ]
}

Errors

StatusCodeWhen
401unauthorizedThe API key is missing, invalid or revoked.
403forbiddenThe key does not have the scope this endpoint needs.

Every error has the same shape. See Errors.