Sign in

v1

latestOpenAPI 3.0.32026-07-26737274.2 KB
Forms

List subscribers for a form

Returns a cursor-paginated list of subscribers who joined through (or were added to) the form. By default only active subscribers are returned — use status (active, inactive, bounced, complained, cancelled, or all) to widen the search.

Filter by when they were added to the form with added_after/added_before, or by when the subscriber record was created with created_after/created_before. Set slim=true to omit expensive optional fields for a faster, smaller response.

get/v4/forms/{form_id}/subscribers

Path parameters

form_idinteger required

Query parameters

added_afterstring nullable

Filter subscribers who have been added to the form after this date (format yyyy-mm-dd)

added_beforestring nullable

Filter subscribers who have been added to the form before this date (format yyyy-mm-dd)

{"stackTrail":"paths:/v4/forms/{form_id}/subscribers:get:parameters:2:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch next page of results, use ?after=<end_cursor>

{"stackTrail":"paths:/v4/forms/{form_id}/subscribers:get:parameters:3:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch previous page of results, use ?before=<start_cursor>

created_afterstring nullable

Filter subscribers who have been created after this date (format yyyy-mm-dd)

created_beforestring nullable

Filter subscribers who have been created before this date (format yyyy-mm-dd)

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

{"stackTrail":"paths:/v4/forms/{form_id}/subscribers:get:parameters:8:schema","oasType":"schema","type":"unknown","nullable":true}

Number of results per page. Default 500, maximum 1000.

slimboolean

When true, omits expensive optional fields from the response. Produces a faster, smaller response — useful when extra fields are not needed.

status'active' | 'inactive' | 'bounced' | 'complained' | 'cancelled' | 'all'

Filter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active.

Response

Returns a paginated list of subscribers for the specified form