API Reference

List subscribers

get
https://api.salesautopilot.com/v2/newsletter//subscribers

Returns a paginated list of subscribers for the given list.

Pagination

Use page_size (or the legacy alias limit) and page for pagination.

  • page_size / limit: maximum 25; values above 25 are clamped to 25
  • page: 1-based (defaults to 1)
  • total in the response indicates the total number of matching subscribers

Filtering

  • segment_id: filter by a saved segment (segment ID from the list's segment list)
  • status: filter by active status (1 = active, 0 = unsubscribed, 5 = bounced, …)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Subscriber list (newsletter) ID

Query Params
integer
≤ 25
Defaults to 25

Number of records per page (max 25; alias limit also accepted)

integer
≥ 1
Defaults to 1

Page number (1-based)

integer

Filter results to subscribers matching this segment ID

integer
enum

Filter by active status (1=active, 0=unsubscribed, 5=bounced)

Allowed:
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?