Skip to content
View as Markdown

GET Contacts By Status​

GET
/reports/contacts-by-status

Contact counts grouped by subscription status.

Every known status is always present — statuses with no contacts are returned with a count of 0 rather than omitted — and they come back in a fixed display order: subscribed, unsubscribed, pending, bounced, complained, spammed, transactional. That makes the response safe to render directly without filling gaps.

total is the sum across all statuses, i.e. every contact on the site.

Takes no parameters.

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)

Responses​

Counts per status.

application/json
JSON
{
"stats": [
{
"status": "string",
"count": 0
}
],
"total": 0
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI