Segments

List 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.

get/api/v1/segments

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/segments
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: segments:read)

Query parameters

limitinteger
afterstring

Opaque cursor from a previous response's next_cursor.

Response

Segment list

has_moreboolean required
next_cursorstring nullable required

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

Changes

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