---
title: "Count the contacts a filter matches under each tab"
method: GET
path: "/sequences/{sequence_id}/contacts/groups/"
tags: ["sequences"]
---

# Count the contacts a filter matches under each tab

`GET /sequences/{sequence_id}/contacts/groups/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

How the contacts matching a search or filter split across the Audience tab's tabs (In progress, Needs approval, Paused, Done, Blocked), judged as list_sequence_contacts' 'group' lists them under the same filters, so each count is the length of that tab's filtered list. 'total' counts every match; 'capped' says more contacts match than one read judges. The page's tabs read it while its search box or a filter is on; get_audience_eligibility counts the whole roster.

## Path parameters

- `sequence_id` string, uuid, required

## Query parameters

- `statuses` EnrolmentStatus[], nullable
- `stop_reasons` StopReason[], nullable
- `exclude` boolean
- `search` string, nullable
- `created_from` string, date-time, nullable
- `created_to` string, date-time, nullable

## Response `200`

Successful Response

- ContactsPerGroupReadSchema: How the contacts a roster filter matches split across the Audience tab's tabs.
  - `capped` boolean, required: More contacts match than one read judges, so each tab's count is at least that many.
  - `groups` ContactGroupCountsReadSchema, required: How many contacts sit under each of the Audience tab's tabs; they add up to ``checked``.
    - `blocked` integer, required: Cannot go on: no address reaches them, do not contact, in another sequence, contacted too recently, bounced, their mailbox removed, or a step that stopped on an error.
    - `done` integer, required: Nothing left to do: finished, replied, unsubscribed, stopped or removed, or found already connected by a Withdraw.
    - `in_progress` integer, required: Still in the cadence; a draft's roster, which the tab names Not started.
    - `needs_approval` integer, required: A message waiting on the customer's approval.
    - `paused` integer, required: Paused by hand, or in the cadence of a paused sequence.
  - `total` integer, required: Every contact the filters match: the All tab's count.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found.
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)