fcrm list contacts
fcrm_list_contactsRetrieve a paginated list of FluentCRM contacts with simple or advanced filtering by tags, lists, statuses, and custom fields.
Instructions
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| tags | No | Filter by tag IDs (simple filter mode only). | |
| lists | No | Filter by list IDs (simple filter mode only). | |
| search | No | Search contacts by name, email, or other searchable fields. | |
| account | No | Exact configured private account profile label; not a tenant or provider account ID. | |
| sort_by | No | Column to sort by. | id |
| per_page | No | Number of contacts per page. | |
| statuses | No | Filter by contact statuses (simple filter mode only). | |
| sort_type | No | Sort direction. | DESC |
| company_ids | No | Filter by company IDs. | |
| filter_type | No | Type of filtering to apply. | simple |
| has_commerce | No | Filter by commerce integration availability. | |
| sms_statuses | No | Filter by SMS statuses (simple filter mode only). | |
| custom_fields | No | Set to `true` to include custom field values in the response. | |
| advanced_filters | No | JSON-encoded advanced filter groups (advanced filter mode only). |