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.

GET /api/v1/contacts/stats

cURL

curl -X GET "https://algapsa.com/api/v1/contacts/stats" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contacts/stats", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/contacts/stats");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "total_contacts": 0,
    "active_contacts": 0,
    "inactive_contacts": 0,
    "contacts_with_client": 0,
    "contacts_without_client": 0,
    "contacts_by_role": {},
    "recent_contacts": 0
  },
  "meta": {}
}