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

# Live Search Autocomplete

> Return suggestions for the open-ended filter fields of live search. Live search uses a
different value vocabulary than indexed search, so use this endpoint, not
`/person/search/autocomplete`, to find values for `/person/professional_network/search/live`
and `/company/professional_network/search/live`. One endpoint serves both.

`field` takes one of four values. Use each returned `value` as is in the matching live
search filter:

| `field`    | Live search filter                 |
| ---------- | ---------------------------------- |
| `title`    | `CURRENT_TITLE`, `PAST_TITLE`      |
| `industry` | `INDUSTRY`                         |
| `region`   | `REGION`, `COMPANY_HEADQUARTERS`   |
| `school`   | `SCHOOL`                           |

`query` must not be blank. A query with no match returns `200` with an empty `suggestions`
list.

Pricing: free.

Gated: available when enabled for your enterprise plan. Support enables it on request, separately from the live search endpoints.

<Note>
    Default `rate-limit` is 45 requests per minute. Send an email to [gtm@crustdata.co](mailto:gtm@crustdata.co) to discuss higher limits if needed for your use case.
</Note>




## OpenAPI

````yaml /openapi-specs/2025-11-01/person.yaml post /professional_network/search/autocomplete
openapi: 3.0.3
info:
  title: Person Dataset API
  version: '2025-11-01'
  description: >
    The Person Dataset API provides a comprehensive suite of endpoints for
    discovering, enriching, and managing person data at scale.


    - **Search**: Query the person database using flexible filters, sorting, and
    pagination to find people matching specific criteria such as job title,
    company, location, and more.

    - **Enrich**: Enrich person records from the cached dataset using profile
    URLs, returning detailed professional information.

    - **Live Enrich**: Fetch fresh profile data from the web when a profile is
    not yet in the cache or when the latest data is needed.

    - **Autocomplete**: Get type-ahead suggestions for person search fields,
    useful for building search UIs with field value previews.

    - **Realtime Search**: Search people in real time using live person search
    filters, supporting both synchronous and asynchronous (background job)
    modes.
servers:
  - url: https://api.crustdata.com
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Person APIs
    description: Core person data operations
  - name: Search APIs
    description: Endpoints for searching and discovering people
  - name: Enrich APIs
    description: Endpoints for enriching person records
  - name: Autocomplete APIs
    description: Endpoints for field value autocomplete suggestions
paths:
  /professional_network/search/autocomplete:
    post:
      tags:
        - Person APIs
        - Autocomplete APIs
      summary: Get suggestions for live search filter values
      description: >
        Return suggestions for the open-ended filter fields of live search. Live
        search uses a

        different value vocabulary than indexed search, so use this endpoint,
        not

        `/person/search/autocomplete`, to find values for
        `/person/professional_network/search/live`

        and `/company/professional_network/search/live`. One endpoint serves
        both.


        `field` takes one of four values. Use each returned `value` as is in the
        matching live

        search filter:


        | `field`    | Live search filter                 |

        | ---------- | ---------------------------------- |

        | `title`    | `CURRENT_TITLE`, `PAST_TITLE`      |

        | `industry` | `INDUSTRY`                         |

        | `region`   | `REGION`, `COMPANY_HEADQUARTERS`   |

        | `school`   | `SCHOOL`                           |


        `query` must not be blank. A query with no match returns `200` with an
        empty `suggestions`

        list.


        Pricing: free.


        Gated: available when enabled for your enterprise plan. Support enables
        it on request, separately from the live search endpoints.


        <Note>
            Default `rate-limit` is 45 requests per minute. Send an email to [gtm@crustdata.co](mailto:gtm@crustdata.co) to discuss higher limits if needed for your use case.
        </Note>
      operationId: autocompleteProfessionalNetworkLiveSearch
      parameters:
        - $ref: '#/components/parameters/ApiVersion'
      requestBody:
        required: true
        description: >-
          The live search field to get values for, the text to match, and an
          optional `limit` (1 to 50, default 20).
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfessionalNetworkAutocompleteRequest'
            examples:
              industry:
                summary: Industries matching "tech"
                value:
                  field: industry
                  query: tech
                  limit: 3
              region:
                summary: Regions matching "new york"
                value:
                  field: region
                  query: new york
                  limit: 3
              title:
                summary: Titles matching "technical account"
                value:
                  field: title
                  query: technical account
                  limit: 3
              school:
                summary: Schools matching "harvard univ"
                value:
                  field: school
                  query: harvard univ
                  limit: 3
      responses:
        '200':
          headers:
            X-Credits-Used:
              $ref: '#/components/headers/XCreditsUsed'
          description: Suggestions for the requested live search field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfessionalNetworkAutocompleteResponse'
              examples:
                industry:
                  summary: Industries matching "tech"
                  value:
                    suggestions:
                      - value: Technical and Vocational Training
                      - value: Technology, Information and Internet
                      - value: Technology, Information and Media
                region:
                  summary: Regions matching "new york"
                  value:
                    suggestions:
                      - value: New York City Metropolitan Area
                      - value: New York County, New York, United States
                      - value: New York Mills, Minnesota, United States
                no_match:
                  summary: A query with no match
                  value:
                    suggestions: []
        '400':
          headers:
            X-Credits-Used:
              $ref: '#/components/headers/XCreditsUsed'
          description: >-
            Invalid request. `field` is not one of the four values, `field` or
            `query` is missing, `query` is blank, `limit` is out of range, or
            the body has a key the endpoint does not take.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unknown_field:
                  summary: Unsupported field
                  value:
                    error:
                      type: invalid_request
                      message: >-
                        'field' must be one of: industry, region, title, school.
                        Got 'bogus'.
                      metadata:
                        - field: field
                          type: enum
                          message: >-
                            'field' must be one of: industry, region, title,
                            school. Got 'bogus'.
                missing_query:
                  summary: No query
                  value:
                    error:
                      type: invalid_request
                      message: 'Missing required field: ''query''.'
                      metadata:
                        - field: query
                          type: missing
                          message: 'Missing required field: ''query''.'
                blank_query:
                  summary: Blank query
                  value:
                    error:
                      type: invalid_request
                      message: 'query: This field may not be blank.'
                      metadata: []
                limit_over_50:
                  summary: limit from 51 to 100
                  value:
                    error:
                      type: invalid_request
                      message: 'count: Ensure this value is less than or equal to 50.'
                      metadata: []
                limit_over_100:
                  summary: limit over 100
                  value:
                    error:
                      type: invalid_request
                      message: '''limit'' must be at most 100. Got 101.'
                      metadata:
                        - field: limit
                          type: less_than_equal
                          message: '''limit'' must be at most 100. Got 101.'
                unknown_key:
                  summary: A key the endpoint does not take
                  value:
                    error:
                      type: invalid_request
                      message: '''foo'' is not a valid parameter.'
                      metadata:
                        - field: foo
                          type: extra_forbidden
                          message: '''foo'' is not a valid parameter.'
        '401':
          description: >-
            Unauthorized. The `Authorization` header is missing or carries an
            invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_api_key:
                  summary: Invalid or missing API key
                  value:
                    error:
                      type: unauthorized
                      message: Invalid API key in request.
                      metadata: []
        '403':
          headers:
            X-Credits-Used:
              $ref: '#/components/headers/XCreditsUsed'
          description: >-
            Forbidden. This endpoint is not enabled on your account. It is gated
            separately from the live search endpoints, so ask support to enable
            it on request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                endpoint_not_enabled:
                  summary: The account is not entitled to this endpoint
                  value:
                    error:
                      type: permission_error
                      message: >-
                        You do not have permission to access
                        /professional_network/search/autocomplete.
                      metadata: []
        '500':
          headers:
            X-Credits-Used:
              $ref: '#/components/headers/XCreditsUsed'
          description: Internal server error. Retry the request after a short delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    ApiVersion:
      name: x-api-version
      in: header
      required: true
      schema:
        type: string
        enum:
          - '2025-11-01'
        default: '2025-11-01'
        example: '2025-11-01'
      description: API version to use. This endpoint currently requires `2025-11-01`.
  schemas:
    ProfessionalNetworkAutocompleteRequest:
      type: object
      required:
        - field
        - query
      properties:
        field:
          type: string
          enum:
            - industry
            - region
            - title
            - school
          description: The live search field to get values for.
          example: industry
        query:
          type: string
          minLength: 1
          description: Text to match against the field's values. Must not be blank.
          example: tech
        limit:
          type: integer
          minimum: 1
          maximum: 50
          default: 20
          description: Maximum number of suggestions to return.
      description: Request body for live search autocomplete.
      example:
        field: industry
        query: tech
        limit: 3
    ProfessionalNetworkAutocompleteResponse:
      type: object
      properties:
        suggestions:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
                description: A value to use as is in the matching live search filter.
                example: Technology, Information and Internet
            required:
              - value
      required:
        - suggestions
      description: Suggestions for a live search field.
      example:
        suggestions:
          - value: Technology, Information and Internet
    ErrorResponse:
      type: object
      description: >-
        Standard error response returned by all Person API endpoints when a
        request fails.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              enum:
                - invalid_request
                - authentication_error
                - unauthorized
                - insufficient_credits
                - permission_error
                - rate_limit_error
                - service_unavailable
                - internal_error
              description: Category of the error
              example: invalid_request
            message:
              type: string
              description: Human-readable error message
              example: 'Unsupported filter field: ''current_title'''
            metadata:
              type: array
              items:
                type: object
                additionalProperties: true
              default: []
              description: >-
                Additional structured context (e.g., available_fields,
                sortable_fields)
  headers:
    XCreditsUsed:
      description: >-
        Exact credits this request deducted, as a decimal string (for example
        `3` or `0.03`). Present on success and error responses alike; `0` when
        the request deducted nothing (free endpoints, error responses, and
        asynchronous job submissions billed when the job runs). Responses
        generated before a request reaches the API, such as rate-limit `429`s,
        do not carry it.
      schema:
        type: string
        example: '0.03'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key passed as a Bearer token in the Authorization header.

````

## Related topics

- [Pricing](https://docs.crustdata.com/general/pricing.md)
- [Person Autocomplete API](https://docs.crustdata.com/person-docs/autocomplete/introduction.md)
- [Job Autocomplete API](https://docs.crustdata.com/job-docs/autocomplete/introduction.md)
- [Company Autocomplete API](https://docs.crustdata.com/company-docs/autocomplete/introduction.md)
- [Company Discovery Watcher](https://docs.crustdata.com/watcher-docs/company/discovery.md)
