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

# Suggest company filter values

> Suggests company names (`company`), headquarters places (`location`, values of `headquartersCity`) or states (`state`, values of `headquartersStateName`) as they are typed. `orgType=investor` narrows company names to investors, for the `investors` filter.

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



## OpenAPI

````yaml /openapi.json get /v1/companies/autocomplete
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/autocomplete:
    get:
      tags:
        - Companies
      summary: Suggest company filter values
      description: >-
        Suggests company names (`company`), headquarters places (`location`,
        values of `headquartersCity`) or states (`state`, values of
        `headquartersStateName`) as they are typed. `orgType=investor` narrows
        company names to investors, for the `investors` filter.


        Free. **Scope:** search. Read-only keys may call it.
      operationId: getCompaniesAutocomplete
      parameters:
        - name: field
          in: query
          required: true
          description: >-
            The filter to suggest values for: company names, headquarters
            places, or states.
          schema:
            type: string
            enum:
              - company
              - location
              - state
        - name: q
          in: query
          required: true
          description: What has been typed so far, two characters or more.
          schema:
            type: string
            minLength: 2
            maxLength: 200
          example: mae
        - name: orgType
          in: query
          required: false
          description: >-
            `investor` narrows `field=company` to investors. Only with
            `field=company`.
          schema:
            type: string
            enum:
              - investor
        - name: countries
          in: query
          required: false
          description: >-
            Only with `field=state`: comma-separated countries whose states to
            suggest, as `USA` or `US`. Without it, every country's.
          schema:
            type: string
            maxLength: 1000
            pattern: ^[A-Za-z]{2,3}(\s*,\s*[A-Za-z]{2,3})*$
        - name: excludedCountries
          in: query
          required: false
          description: >-
            Only with `field=state`: comma-separated countries whose states to
            leave out.
          schema:
            type: string
            maxLength: 1000
            pattern: ^[A-Za-z]{2,3}(\s*,\s*[A-Za-z]{2,3})*$
      responses:
        '200':
          description: Suggested values for the filter.
          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:
                  - field
                  - suggestions
                properties:
                  field:
                    type: string
                    enum:
                      - company
                      - location
                      - state
                  suggestions:
                    type: array
                    items:
                      type: object
                      required:
                        - name
                      additionalProperties: true
                      properties:
                        name:
                          type: string
                          description: The value to send in the filter.
                        domain:
                          type: string
                          description: >-
                            For `field=company`: the company's website domain,
                            when known.
                        country:
                          type: string
                          description: >-
                            For `field=state`: the state's country, which tells
                            same-named states apart.
              example:
                field: company
                suggestions:
                  - name: A.P. Moller - Maersk
                    domain: maersk.com
        '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.