Skip to content
View as Markdown

GET Fetch Contact Export Page​

GET
/subscribers-export

Fetch one page of contact-export rows. The admin export runs by calling this repeatedly and assembling the CSV client-side, which is what keeps a six-figure export from timing out in a single request.

Paging is fixed at 500 rows per request and cannot be changed. Keep requesting while has_more is true, incrementing page.

total and headers are returned only on page 1 — capture them on the first call, because later pages carry just page, rows, and has_more.

The maximum page is 200, a hard ceiling of 100,000 rows per export; beyond that the endpoint returns 400.

filter_type selects one of two mutually exclusive branches: simple reads tags, lists, and statuses, while advanced reads advanced_filters and ignores the others.

This is the same handler as POST /subscribers-export, with parameters read from the query string. Array parameters must be sent in bracket form (columns[]=email). For anything but a small column list, prefer the POST form — long selections overflow practical URL length limits.

Required capability: fcrm_manage_contacts_export

Enforced by ExportPolicy::verifyRequest(), the policy default for this route group.

Requires: FluentCampaign Pro. Without it the route does not exist.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

columns[]

Contact columns to export. Required.

Type
array
custom_fields[]

Custom field keys to add as columns.

Type
array
commerce_columns[]

Commerce columns to append. Forces has_commerce on.

Type
array
page

1-based export page. Page size is fixed at 500; maximum page is 200.

Type
integer
Default
1
limit

Cap on total rows across all pages.

Type
integer
offset

Rows to skip before the first exported row.

Type
integer
filter_type

Which filtering branch to use.

Type
string
Valid values
"simple""advanced"
Default
"simple"
tags[]

Tag ids (simple filtering only).

Type
array
lists[]

List ids (simple filtering only).

Type
array
statuses[]

Contact statuses (simple filtering only).

Type
array
advanced_filters

JSON-encoded filter groups (advanced filtering only).

Type
string
contact_ids[]

Export only these contacts.

Type
array
company_ids[]

Restrict to these companies.

Type
array
search

Search term applied to the contact query.

Type
string
sort_by

Column to sort by.

Type
string
Default
"id"
sort_type

Sort direction.

Type
string
Valid values
"ASC""DESC"
Default
"DESC"
has_commerce

Restrict to contacts that have commerce data.

Type
string

Responses​

One page of export rows.

application/json
JSON
{
"page": 0,
"total": 0,
"headers": [
"string"
],
"rows": [
[
]
],
"has_more": true
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI