FluentCRM Developers

Appearance

View as Markdown

GET Subscribers Export Page​

GET
/subscribers-export

Retrieve one page of export-ready subscriber rows. This legacy GET route is kept for backward compatibility, but POST /subscribers-export is preferred because filter payloads can exceed URL limits. Requires FluentCampaign Pro.

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[]*

Columns to export. Must be a non-empty array.

Type
array
Required
custom_fields[]

Custom field keys to include in the export.

Type
array
commerce_columns[]

Commerce-related export columns.

Type
array
company_ids[]

Company IDs to filter by.

Type
array
page

Export page number. Each page contains up to 500 rows.

Type
integer
Default
1
filter_type

Filter mode. Use simple for tags/lists/statuses filters or advanced for raw filter groups.

Type
string
Valid values
"simple""advanced"
Default
"simple"
search

Search term for subscriber lookup.

Type
string
sort_by

Sort column.

Type
string
Default
"id"
sort_type

Sort direction.

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

Whether to restrict the export to contacts with commerce data.

Type
boolean
contact_ids[]

Specific contact IDs to export.

Type
array
advanced_filters

Raw advanced filter groups when filter_type=advanced.

Type
string
tags[]

Tag filters for simple mode.

Type
array
statuses[]

Subscriber statuses for simple mode.

Type
array
lists[]

List filters for simple mode.

Type
array
limit

Optional user-facing export limit, capped at 100000 rows.

Type
integer
offset

Optional starting offset.

Type
integer

Responses​

Export page retrieved successfully.

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

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI