fcrm list lists
fcrm_list_listsFetch paginated FluentCRM contact lists with search, sorting, and optional subscriber counts. Add a flat all_lists array for dropdowns or exclude counts to reduce payload size.
Instructions
Retrieve a paginated list of contact lists. Optionally includes subscriber counts and a separate array of all lists for dropdown/select usage.
Required capability: fcrm_manage_contact_cats
Enforced by ListPolicy::verifyRequest(), the policy default for this route group.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination. | |
| with | No | Extra data to include. `subscribersCount` adds per-list contact counts via one grouped pivot query. | |
| search | No | Search lists by title, slug, or description. | |
| 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 lists per page. | |
| all_lists | No | If set to any truthy value, includes a flat `all_lists` array with id, title, and slug of every list (useful for dropdowns). | |
| sort_order | No | Sort direction. | DESC |
| exclude_counts | No | If set to any truthy value, `totalCount` and `subscribersCount` will not be included for each list. |