---
title: "Get contact statistics"
method: GET
path: "/companies/{company}/contacts/stats"
tags: ["Contacts"]
---

# Get contact statistics

`GET /companies/{company}/contacts/stats`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/contacts/stats`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Return aggregate counts for unique canonical contacts and their cumulative customer, supplier and lead roles. A contact with both customer and supplier roles counts once in `total` and once in `dual_role`; role counters intentionally overlap.

## Path parameters

- `company` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` BusinessContactStats, required: Aggregated counters for canonical identities and their cumulative customer, supplier and fiscal lead roles. A contact with multiple roles is counted once in `total` and in each applicable role counter.
    - `object` 'contact_stats', required
    - `total` integer, required
    - `customer` integer, required
    - `supplier` integer, required
    - `unassigned` integer, required
    - `lead` integer, required
    - `active_lead` integer, required
    - `inactive_lead` integer, required
    - `dual_role` integer, required
    - `person` integer, required
    - `company` integer, required
    - `active_customer` integer, required
    - `inactive_customer` integer, required
    - `active_supplier` integer, required
    - `inactive_supplier` integer, required
    - `archived` integer, required
    - `with_email` integer, required
    - `with_phone` integer, required
    - `new_this_month` integer, required

## Other responses

- `400`: The request is syntactically malformed — e.g. an unknown query parameter, an integer parameter with non-numeric value, or a value outside the documented range. `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`). `company_inactive`: the company in the path is deactivated; reactivate it to operate.
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)