FluentCRM Developers

Appearance

View as Markdown
Enter your site to enable Send. Requests are sent from your browser, so the site must allow cross-origin calls (CORS).

GET List Contacts​

GET
/subscribers

Retrieve a paginated list of contacts. Supports both simple filtering (by tags, lists, statuses) and advanced filtering with complex filter groups. Optionally includes custom field values.

Required capability: fcrm_read_contacts or fcrm_manage_contacts — which one applies depends on the action being performed.

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

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

filter_type

Type of filtering to apply.

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

Search text. Every word must match the first name, last name or email. Also supported: "quoted phrase", a full or partial email, a phone number (compared on digits, 6 or more), #123 for a contact ID, and field:value scoped to one field (id, email, name, first_name/first, last_name/last, phone, address, city, state, postal_code/zip, country, source) or to a custom field by its slug. Quote a scoped value that has spaces: city:"new york". Terms combine with AND; at most 20 terms are read. A key:value with an unknown key is searched as plain text.

Type
string
search_custom_fields

Also match free search text against contact custom-field values. Accepts true, 1 or yes.

Type
string
Valid values
"true""false""yes""no""1""0"
sort_by

Column to sort by. relevance ranks search matches (exact before prefix before contains); without a search it falls back to id order.

Type
string
Default
"id"
sort_type

Sort direction.

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

Filter by commerce integration availability.

Type
string
custom_fields

Set to true to include custom field values in the response.

Type
string
Valid values
"true""false"
tags[]

Filter by tag IDs (simple filter mode only).

Type
array
statuses[]

Filter by contact statuses (simple filter mode only).

Type
array
sms_statuses[]

Filter by SMS statuses (simple filter mode only).

Type
array
lists[]

Filter by list IDs (simple filter mode only).

Type
array
company_ids[]

Filter by company IDs.

Type
array
advanced_filters

JSON-encoded advanced filter groups (advanced filter mode only).

Type
string
with_status_counts

Also return status_counts, the number of matching contacts per status (ignoring the status filter). Simple filter mode only. Accepts true, 1 or yes.

Type
string
Valid values
"true""false""yes""no""1""0"
per_page

Number of contacts per page.

Type
integer
Default
15
page

Page number for pagination.

Type
integer
Default
1

Responses​

Paginated list of contacts.

application/json
JSON
{
"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,
"user_id": "string",
"hash": "string",
"contact_owner": "string",
"company_id": 0,
"prefix": "string",
"first_name": "string",
"last_name": "string",
"full_name": "string",
"email": "string",
"status": "string",
"contact_type": "string",
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "string",
"state": "string",
"country": "string",
"ip": "string",
"latitude": 0,
"longitude": 0,
"phone": "string",
"timezone": "string",
"date_of_birth": "string",
"source": "string",
"life_time_value": 0,
"last_activity": "string",
"total_points": 0,
"created_at": "string",
"updated_at": "string",
"photo": "string",
"tags": [
{
"id": 0,
"title": "string",
"slug": "string"
}
],
"lists": [
{
"id": 0,
"title": "string",
"slug": "string"
}
],
"stats": {
"emails": 0,
"opens": 0,
"clicks": 0,
"total_points": 0,
"last_activity": "string"
}
}
]
},
"custom": "string",
"search_meta": {
"custom_fields": true,
"mode": "string",
"text": "string",
"words": [
"string"
],
"ids": [
0
],
"scoped": [
{
"key": "string",
"field": "string",
"value": "string",
"custom": true
}
],
"unknown": [
"string"
]
},
"status_counts": {
"additionalProperties": 0
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI