Skip to Content
SendlySendly
API ReferenceSegments

List segments

GET
/api/v1/segments

Cursor-paginated list of segments, newest first. Pass the previous response's next_cursor as after to page forward; has_more is false and next_cursor is null on the last page.

member_count is materialized on each segment, so listing segments never fans out into one count per segment — it is refreshed as membership changes rather than computed on read.

Requires the segments:read scope — View your segments and who belongs to them.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

limit?integer
Range1 <= value <= 100
Default20
after?string

Opaque cursor from a previous response's next_cursor.

Length1 <= length

Response Body

Segment list

application/json
  1. response

Cursor-paginated list of segments.

data*array<>
has_more*boolean
next_cursor*|

Pass as after to fetch the next page. null on the last page.

Example Request
curl -X GET 'https://api.sendly.now/api/v1/segments'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "type": "DYNAMIC",      "condition": {        "logic": "AND",        "groups": [          {            "filters": [              {                "field": "string",                "operator": "equals",                "value": null,                "unit": "days"              }            ],            "conditions": {}          }        ]      },      "track_membership": true,      "member_count": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}