> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Count the contacts a filter matches under each tab

> 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.



## OpenAPI

````yaml /openapi.json get /sequences/{sequence_id}/contacts/groups/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's approval threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: >-
      The approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for creating and managing integrations.
    name: integrations
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: >-
      The Model Context Protocol endpoint: use Oneprofile from Claude Code,
      Claude Desktop, Cursor or any other MCP client, with an API key as the
      bearer token.
    name: mcp
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for teaching a saved agent from example rows: training sessions,
      per-row feedback, and the proposed prompt to approve.
    name: agent-training
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalogue endpoint behind the picker
      that builds them.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context (company description,
      ideal customer profile, buyer personas, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /sequences/{sequence_id}/contacts/groups/:
    get:
      tags:
        - sequences
      summary: Count the contacts a filter matches under each tab
      description: >-
        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.
      operationId: count_sequence_contacts_per_group
      parameters:
        - in: path
          name: sequence_id
          required: true
          schema:
            format: uuid
            title: Sequence Id
            type: string
        - in: query
          name: statuses
          required: false
          schema:
            anyOf:
              - items:
                  $ref: '#/components/schemas/EnrolmentStatus'
                type: array
              - type: 'null'
            title: Statuses
        - in: query
          name: stop_reasons
          required: false
          schema:
            anyOf:
              - items:
                  $ref: '#/components/schemas/StopReason'
                type: array
              - type: 'null'
            title: Stop Reasons
        - in: query
          name: exclude
          required: false
          schema:
            default: false
            title: Exclude
            type: boolean
        - in: query
          name: search
          required: false
          schema:
            anyOf:
              - maxLength: 255
                type: string
              - type: 'null'
            title: Search
        - in: query
          name: created_from
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            title: Created From
        - in: query
          name: created_to
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            title: Created To
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactsPerGroupReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    EnrolmentStatus:
      description: >-
        Where one contact stands in one sequence.


        ACTIVE rows carry a ``due_at`` and are what the tick claims; CLAIMED is
        the

        in-flight guard between claim and outcome. PAUSED is a deliberate

        per-contact hold: unclaimable because the tick claims strictly on
        ACTIVE,

        yet still LIVE. It keeps its step and its one-live-sequence slot, and a

        compliance stop (reply, unsubscribe) reaches it. Everything else is

        settled: COMPLETED walked off the end; STOPPED was halted (reply,

        unsubscribe, bounce, manual, company pause); FAILED is terminal;

        SUPPRESSED was on the do-not-contact list;

        SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the

        reason visible in the grid.


        A contact the workspace's recontact rule refuses is STOPPED with

        ``StopReason.COOLDOWN``. There is deliberately no held state: a cooldown

        settles a contact rather than parking them, so nothing here waits on a
        date

        and nothing lets itself out later.


        AWAITING_ACTION is a contact parked behind a task that needs a

        person or a channel, modelled on PAUSED: live, keeps its step and its

        one-live-sequence slot, unclaimable because the tick claims strictly on

        ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it
        by

        hand: only the outreach-task sweep does, once the task it waits on is

        decided or delivered. Deliberately not "awaiting approval": an AUTO-mode

        LinkedIn park is waiting for a browser rather than for anyone's
        approval,

        and this value is the word the Contacts tab shows for both.


        PENDING is a draft's roster: in, standing on a step, and NOT live.
        Binding

        an audience enrols on the spot so the Contacts tab can show who is in,
        but

        a sequence nobody has launched must not hold anybody's one-live-sequence

        slot, or a second sequence written for the same people skips them all.

        ``uq_sequence_enrolment_one_live`` leaves PENDING out, the tick never

        claims it, and launch turns each row ACTIVE, settling the ones another

        sequence took meanwhile as SKIPPED_DUPLICATE.
      enum:
        - pending
        - active
        - claimed
        - paused
        - awaiting_action
        - completed
        - stopped
        - failed
        - suppressed
        - skipped_duplicate
      title: EnrolmentStatus
      type: string
    StopReason:
      enum:
        - reply
        - unsubscribe
        - bounce
        - manual
        - company_reply
        - row_left_audience
        - step_removed
        - removed
        - cooldown
        - rejected
        - mailbox_removed
      title: StopReason
      type: string
    ContactsPerGroupReadSchema:
      description: >-
        How the contacts a roster filter matches split across the Audience tab's
        tabs.
      properties:
        capped:
          description: >-
            More contacts match than one read judges, so each tab's count is at
            least that many.
          title: Capped
          type: boolean
        groups:
          $ref: '#/components/schemas/ContactGroupCountsReadSchema'
          description: >-
            How many of the matching contacts sit under each tab. Each one sits
            under exactly one, and list_sequence_contacts' 'group' with the same
            filters lists them.
        total:
          description: 'Every contact the filters match: the All tab''s count.'
          title: Total
          type: integer
      required:
        - total
        - capped
        - groups
      title: ContactsPerGroupReadSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    ContactGroupCountsReadSchema:
      description: >-
        How many contacts sit under each of the Audience tab's tabs; they add up
        to ``checked``.
      properties:
        blocked:
          description: >-
            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.
          title: Blocked
          type: integer
        done:
          description: >-
            Nothing left to do: finished, replied, unsubscribed, stopped or
            removed, or found already connected by a Withdraw.
          title: Done
          type: integer
        in_progress:
          description: >-
            Still in the cadence; a draft's roster, which the tab names Not
            started.
          title: In Progress
          type: integer
        needs_approval:
          description: A message waiting on the customer's approval.
          title: Needs Approval
          type: integer
        paused:
          description: Paused by hand, or in the cadence of a paused sequence.
          title: Paused
          type: integer
      required:
        - in_progress
        - needs_approval
        - paused
        - done
        - blocked
      title: ContactGroupCountsReadSchema
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.