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

# Count companies

> Counts the companies a search would find, without listing them. Send exactly one of `query`, `filters`, `savedSearchId` or `savedSearchName`, as the search takes them.

A new count runs in the background: the first answer is `202` with `status` `pending`. Send the same request again every few seconds until it answers `200` with `status` `ready` and the `total`.

Free. **Scope:** search. Read-only keys may call it.



## OpenAPI

````yaml /openapi.json post /v1/companies/count
openapi: 3.1.0
info:
  title: outbound.dev API
  version: v1
  description: Find people and companies, and see what every call costs, with one API key.
servers:
  - url: https://api.outbound.dev
security: []
tags:
  - name: People
    description: >-
      Search people with filters, a saved search or a plain-language query,
      count matches and look up filter values.
  - name: Companies
    description: >-
      Search companies, count matches, name one company by its name, domain or
      LinkedIn page, and list its people.
  - name: Saved searches
    description: Keep a search under a title and run it again, for people or for companies.
  - name: Jobs
    description: >-
      Long tasks a call started: their progress, what they produced and what
      they were charged.
  - name: Account
    description: >-
      The calling key and its organization, its rate limits, and revoking the
      key.
  - name: Billing
    description: The balance, the ledger of every change to it, and the price list.
  - name: Usage and requests
    description: >-
      Calls and spend by day, and the record of every request of the last 30
      days.
paths:
  /v1/companies/count:
    post:
      tags:
        - Companies
      summary: Count companies
      description: >-
        Counts the companies a search would find, without listing them. Send
        exactly one of `query`, `filters`, `savedSearchId` or `savedSearchName`,
        as the search takes them.


        A new count runs in the background: the first answer is `202` with
        `status` `pending`. Send the same request again every few seconds until
        it answers `200` with `status` `ready` and the `total`.


        Free. **Scope:** search. Read-only keys may call it.
      operationId: postCompaniesCount
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: >-
                    Which companies to find, in plain language. It is turned
                    into filters, which the page answers with as `filters`.
                  minLength: 1
                  maxLength: 2000
                  example: logistics companies in Portugal
                filters:
                  type: object
                  description: >-
                    Filters by name, with values from `GET
                    /v1/companies/filters` and `GET /v1/companies/autocomplete`.
                  maxProperties: 100
                  additionalProperties: {}
                  example:
                    headquartersCountryCode:
                      - PRT
                savedSearchId:
                  type: string
                  description: Run a saved company search by its id.
                  minLength: 24
                  maxLength: 24
                  pattern: ^[0-9a-fA-F]+$
                savedSearchName:
                  type: string
                  description: >-
                    Run a saved company search by its title. A title several
                    saved searches share answers 409
                    `saved_search_name_ambiguous`.
                  minLength: 1
                  maxLength: 255
            example:
              query: logistics companies in Portugal
      responses:
        '200':
          description: The count is ready.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Charged-Usd:
              $ref: '#/components/headers/ChargedUsd'
            X-Balance-Usd:
              $ref: '#/components/headers/BalanceUsd'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - total
                  - filters
                properties:
                  status:
                    type: string
                    enum:
                      - ready
                  total:
                    type: integer
                    description: How many match.
                  filters:
                    type: object
                    additionalProperties: true
                    description: >-
                      The filters counted. Send them to the search to list the
                      matches.
                  unresolvedCriteria:
                    type: array
                    items:
                      type: string
                    description: >-
                      With `query`: the parts of it that could not be turned
                      into a filter.
                  closestCompanyMatches:
                    type: array
                    description: >-
                      With `query`: each company it named that the search chose
                      between same-named companies for, and the one chosen.
                    items:
                      type: object
                      required:
                        - requestedName
                        - name
                      properties:
                        requestedName:
                          type: string
                        name:
                          type: string
                        domain:
                          type: string
                  ignoredFilterKeys:
                    type: array
                    items:
                      type: string
                    description: >-
                      With a saved search: stored filters the search no longer
                      takes, left out.
                  unappliedCompanyNames:
                    type: array
                    description: >-
                      Company names in the filters the search could not apply
                      yet, by filter.
                    items:
                      type: object
                      additionalProperties: true
              example:
                status: ready
                total: 1246019
                filters:
                  job_title_levels:
                    - director
                    - vp
                  job_title_role:
                    - operations
        '202':
          description: >-
            Still counting. Send the same request again in a few seconds; a
            count takes up to about a minute and a half.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Charged-Usd:
              $ref: '#/components/headers/ChargedUsd'
            X-Balance-Usd:
              $ref: '#/components/headers/BalanceUsd'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - filters
                properties:
                  status:
                    type: string
                    enum:
                      - pending
                  filters:
                    type: object
                    additionalProperties: true
                    description: >-
                      The filters counted. Send them to the search to list the
                      matches.
                  unresolvedCriteria:
                    type: array
                    items:
                      type: string
                    description: >-
                      With `query`: the parts of it that could not be turned
                      into a filter.
                  closestCompanyMatches:
                    type: array
                    description: >-
                      With `query`: each company it named that the search chose
                      between same-named companies for, and the one chosen.
                    items:
                      type: object
                      required:
                        - requestedName
                        - name
                      properties:
                        requestedName:
                          type: string
                        name:
                          type: string
                        domain:
                          type: string
                  ignoredFilterKeys:
                    type: array
                    items:
                      type: string
                    description: >-
                      With a saved search: stored filters the search no longer
                      takes, left out.
                  unappliedCompanyNames:
                    type: array
                    description: >-
                      Company names in the filters the search could not apply
                      yet, by filter.
                    items:
                      type: object
                      additionalProperties: true
              example:
                status: pending
                filters:
                  job_title_levels:
                    - director
                    - vp
                  job_title_role:
                    - operations
        '429':
          $ref: '#/components/responses/RateLimited'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
        - apiKey: []
components:
  headers:
    RequestId:
      description: The request's id. Quote it when you write to support.
      schema:
        type: string
        example: req_6a1f0c2b9d4e8a7f3c5b2e10
    ChargedUsd:
      description: What this call cost, in US dollars as an exact six-decimal string.
      schema:
        type: string
        example: '0.000500'
    BalanceUsd:
      description: >-
        The organization's balance after this call, in US dollars as an exact
        six-decimal string.
      schema:
        type: string
        example: '9.999500'
    RateLimitLimit:
      description: >-
        The calls allowed in the window of the route's limit with the fewest
        calls left.
      schema:
        type: integer
        example: 20
    RateLimitRemaining:
      description: The calls left in that window.
      schema:
        type: integer
        example: 19
    RateLimitReset:
      description: Seconds until that window resets.
      schema:
        type: integer
        example: 42
    RetryAfter:
      description: Seconds to wait before calling again.
      schema:
        type: integer
        example: 42
  responses:
    RateLimited:
      description: >-
        Too many calls. Wait the seconds in Retry-After, then call again. The
        body is empty.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
    Error:
      description: The request was refused. The body names the reason in `error.code`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: >-
        Something failed on our side and nothing was charged. Retry with
        backoff; quote X-Request-Id if it persists. The body is empty.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - doc_url
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable: branch on it. It never changes
                meaning.
            message:
              type: string
              description: >-
                A human-readable explanation for logs. It may be reworded at any
                time.
            param:
              type: string
              description: The request field the error is about, when there is one.
            doc_url:
              type: string
              description: The code's entry in the errors reference.
            request_id:
              type: string
              description: >-
                The request's id, as in the X-Request-Id header. Quote it to
                support.
      example:
        error:
          code: insufficient_balance
          message: Your balance cannot cover this call. Add funds and try again.
          doc_url: https://outbound.dev/docs/errors#insufficient_balance
          request_id: req_6a1f0c2b9d4e8a7f3c5b2e10
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from the console, starting `ob_live_`, sent as
        `Authorization: Bearer <key>`.

````

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