Segments

List the contacts in a segment

Cursor-paginated members of a segment. For a STATIC segment these are the rows of its membership list; for a DYNAMIC one the saved condition is evaluated against contacts as the page is read, so the result always reflects the contacts as they are now.

Cursors from this endpoint are not interchangeable with cursors from other list endpoints — the ordering differs — and pairing one with the wrong endpoint answers 422 rather than silently paging a different set.

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

get/api/v1/segments/{id}/contacts

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/segments/{id}/contacts
  • 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)

Path parameters

idstring uuid required

Resource id.

Query parameters

limitinteger
afterstring

Opaque cursor from a previous response's next_cursor.

Response

Segment member 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.