API reference · Contacts
GET/api/v1/contacts/stats

Get contact stats

Returns contact statistics using explicit API-key auth and contact:read permission.

RBAC · contact

Response body

Success response 200 · schema ContactStatsEnvelope

dataobjectRequired
total_contactsnumberRequired
active_contactsnumberRequired
inactive_contactsnumberRequired
contacts_with_clientnumberRequired
contacts_without_clientnumberRequired
contacts_by_roleobjectRequired
recent_contactsnumberRequired
metaobject

Response codes

200
Contact stats returned.
401
API key missing/invalid or key user not found.
403
Permission denied for contact read.
500
Unexpected contact stats failure.