FluentCRM Developers

Appearance

View as Markdown

GET Get Dynamic Segment Subscribers​

GET
/dynamic-segments/{slug}/subscribers/{id}

Retrieve a paginated list of subscribers belonging to a specific dynamic segment. Supports sorting, searching, and optional custom field inclusion. Requires FluentCampaign Pro.

Required capability: fcrm_manage_contact_cats

Enforced by DynamicSegmentPolicy::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​

Path Parameters

slug*

The slug of the dynamic segment type (e.g., custom_segment, wordpress_users).

Type
string
Required
id*

The ID of the segment. Use 0 for built-in segments that have no specific ID.

Type
integer
Required

Query Parameters

search

Search subscribers by name or email.

Type
string
sort_by

Column to sort by.

Type
string
sort_type

Sort direction.

Type
string
Valid values
"ASC""DESC"
custom_fields

Set to true to include custom field values for each subscriber.

Type
string
Valid values
"true""false"
has_commerce

If truthy, includes commerce data for each subscriber (requires a commerce provider like WooCommerce).

Type
boolean
per_page

Number of subscribers per page.

Type
integer
Default
15
page

Page number for pagination.

Type
integer
Default
1
tags[]

Restrict the segment's contacts to these tag ids.

Type
array
lists[]

Restrict the segment's contacts to these list ids.

Type
array
statuses[]

Restrict the segment's contacts to these subscription statuses.

Type
array

Responses​

Segment details and paginated list of subscribers.

application/json
JSON
{
"segment": {
},
"subscribers": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"next_page_url": "string",
"prev_page_url": "string",
"from": 0,
"to": 0,
"data": [
{
"id": 0,
"first_name": "string",
"last_name": "string",
"full_name": "string",
"email": "string",
"status": "string",
"contact_type": "string",
"city": "string",
"state": "string",
"country": "string",
"source": "string",
"created_at": "string",
"updated_at": "string",
"last_activity": "string",
"tags": [
{
}
],
"lists": [
{
}
],
"companies": [
{
}
],
"custom_fields": {
}
}
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI