GET Contacts By Lists​
GET
/reports/contacts-by-lists
Paginated contact counts per list, largest first. The list-side counterpart to GET /reports/contacts-by-tags and it behaves identically: empty lists are included with a count of 0, and contact_count is returned as a string.
The pivot join is constrained to object_type = 'FluentCrm\App\Models\Lists', which is what keeps tag memberships out of these counts.
Required capability: fcrm_view_dashboard
Enforced by ReportPolicy::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
per_page
Lists per page.
Type
integer
Default
20page
Page number.
Type
integer
Default
1Responses​
Paginated list counts.
application/json
JSON
{
"lists": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"from": 0,
"to": 0,
"next_page_url": "string",
"prev_page_url": "string",
"data": [
{
"id": 0,
"title": "string",
"contact_count": "string"
}
]
}
}