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

# Preview People

> Runs a people search and returns the first page of the people matched plus `grossTotal`, how many people match in total. There is no further page and no page, size or cursor parameter. Each row carries the person's masked name, role, location, position history and current company, every value verbatim, and never a full name, LinkedIn URL, avatar or contact details. `query` is the flat list of conditions, `{"filters":[{"field":…,"op":…,…}]}`, written in the grammar Get Lead Finder Search Schema publishes for the `version` sent as `schemaVersion`; a query in any other shape is refused before the search, and a condition the grammar does not accept is refused naming it by its path (e.g. `query.filters[3].values`) and, where known, its field and op. Free: consumes no credits. Limit: 100 preview attempts per user, or per API key, in a sliding 24-hour window, regardless of filters or workspace; cached previews and refused attempts count too. Once the limit is reached no search is run and the answer is 429 with `Retry-After`, an approximate wait in seconds, not a guaranteed reset time.



## OpenAPI

````yaml https://api.goextrovert.com/client/v2/docs-json post /client/v2/lead-finder/preview
openapi: 3.1.0
info:
  title: Extrovert Client API
  description: >-
    Public API for Extrovert platform integration. Use your API key for
    authentication.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.goextrovert.com/
    description: API Server
security: []
tags: []
paths:
  /client/v2/lead-finder/preview:
    post:
      tags:
        - Lead Finder
      summary: Preview People
      description: >-
        Runs a people search and returns the first page of the people matched
        plus `grossTotal`, how many people match in total. There is no further
        page and no page, size or cursor parameter. Each row carries the
        person's masked name, role, location, position history and current
        company, every value verbatim, and never a full name, LinkedIn URL,
        avatar or contact details. `query` is the flat list of conditions,
        `{"filters":[{"field":…,"op":…,…}]}`, written in the grammar Get Lead
        Finder Search Schema publishes for the `version` sent as
        `schemaVersion`; a query in any other shape is refused before the
        search, and a condition the grammar does not accept is refused naming it
        by its path (e.g. `query.filters[3].values`) and, where known, its field
        and op. Free: consumes no credits. Limit: 100 preview attempts per user,
        or per API key, in a sliding 24-hour window, regardless of filters or
        workspace; cached previews and refused attempts count too. Once the
        limit is reached no search is run and the answer is 429 with
        `Retry-After`, an approximate wait in seconds, not a guaranteed reset
        time.
      operationId: LeadFinderClientApiController_previewPeople
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewPeopleRequestDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewPeopleResponseDto'
        '400':
          description: >-
            The request is refused before any search: another `schemaVersion`, a
            query not in the flat `{"filters":[…]}` shape, or a condition the
            grammar does not accept, named by its path and, where known, its
            field and op.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiErrorResponseDto'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiErrorResponseDto'
        '429':
          description: >-
            The API key's preview limit is reached; `Retry-After` gives an
            approximate wait in seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiErrorResponseDto'
      security:
        - api-key: []
components:
  schemas:
    PreviewPeopleRequestDto:
      type: object
      properties:
        schemaVersion:
          type: string
          minLength: 1
          description: >-
            The `version` the search schema currently reports, e.g. `people.v1`.
            Any other value is refused.
          examples:
            - people.v1
        query:
          type: object
          properties:
            filters:
              type: array
              items:
                allOf:
                  - type: object
                    properties:
                      field:
                        type: string
                        description: >-
                          The field the condition filters on: a `field` the
                          search schema lists, e.g. `contact.seniority`.
                        examples:
                          - contact.seniority
                          - account.employeeSize
                      op:
                        type: string
                        description: >-
                          The operation: one of the `ops` the search schema
                          lists for that field, e.g. `any.include` or `range`.
                          `all.include`: requires every supplied value to match
                          using the selected match mode; a value containing
                          spaces remains one value.
                        examples:
                          - any.include
                          - range
                    required:
                      - field
                      - op
                    additionalProperties: {}
                    description: >-
                      One condition: `field`, `op` and the payload keys of the
                      field's `control` (for example `mode` and `values`,
                      `values`, `ranges`, `start`/`end`, `min`/`max`, `rows`). A
                      key the control does not take is refused, naming it.
                      `mode`: SMART also matches similar or related values. WORD
                      matches the exact phrase, with extra words allowed before
                      or after it. STRICT matches the complete field value, with
                      no extra words. A `keyword_sources` condition puts `mode`
                      on each `sources[]` entry instead.
                  - {}
              description: >-
                The conditions, combined with AND. Each `field` and `op` pair
                appears at most once, and its one condition holds all of its
                values.
          additionalProperties: false
          description: >-
            The people-search query: the flat list of conditions
            `{"filters":[…]}` in the grammar Get Lead Finder Search Schema
            publishes. A key the grammar does not accept is refused, naming it;
            no key is dropped silently.
          examples:
            - filters:
                - field: contact.titleLatest
                  op: any.include
                  mode: SMART
                  values:
                    - head of sales
                    - sales director
                - field: contact.seniority
                  op: any.include
                  values:
                    - director
                    - head
                    - vp
                - field: contact.location
                  op: any.include
                  values:
                    - Germany
                - field: account.industries
                  op: any.include
                  mode: SMART
                  values:
                    - software development
                - field: account.employeeSize
                  op: range
                  ranges:
                    - start: 51
                      end: 500
          required:
            - filters
      required:
        - schemaVersion
        - query
    PreviewPeopleResponseDto:
      type: object
      properties:
        status:
          type: string
          const: success
          description: Response status
        data:
          type: object
          properties:
            people:
              type: array
              items:
                type: object
                properties:
                  providerId:
                    type: string
                    description: >-
                      Row id of the person in this preview, the only identifier
                      a row carries; a `SELECTED` import names rows by it.
                  maskedName:
                    description: >-
                      First name and masked last name, e.g. `Ada Fr***n`. Never
                      a full name.
                    type: string
                  title:
                    description: Job title.
                    type: string
                  headline:
                    description: Profile headline.
                    type: string
                  seniority:
                    description: >-
                      One of the `contact.seniority` values the search schema
                      publishes.
                    type: string
                  departments:
                    type: array
                    items:
                      type: string
                    description: Departments.
                  subDepartments:
                    type: array
                    items:
                      type: string
                    description: Sub-departments.
                  functions:
                    type: array
                    items:
                      type: string
                    description: Functions.
                  location:
                    description: >-
                      Where the person is now, as one line (`city, country,
                      continent`); the location to show for the person.
                    type: string
                  positions:
                    type: array
                    items:
                      type: object
                      properties:
                        companyName:
                          description: Employer name.
                          type: string
                        dateStart:
                          description: Start date.
                          type: string
                        dateEnd:
                          description: End date; absent for a current role.
                          type: string
                        employeesStart:
                          description: >-
                            Lower bound of the headcount range of that
                            position's employer, per provider data; not the
                            headcount when the person joined or left. The date
                            of this data is unknown, so it may not be current.
                          type: number
                        employeesEnd:
                          description: >-
                            Upper bound of the headcount range of that
                            position's employer, per provider data; not the
                            headcount when the person joined or left. The date
                            of this data is unknown, so it may not be current.
                          type: number
                        location:
                          description: >-
                            Location of that position, when known; not where the
                            person is now.
                          type: string
                    description: Position history, newest first.
                  company:
                    description: The current company card.
                    type: object
                    properties:
                      name:
                        description: Company name.
                        type: string
                      industry:
                        description: Industry name.
                        type: string
                      description:
                        description: Company description.
                        type: string
                      staffTotal:
                        description: The company's current headcount.
                        type: number
                      staffRangeStart:
                        description: >-
                          Lower end of the company's current headcount band; the
                          company size to show.
                        type: number
                      staffRangeEnd:
                        description: Upper end of the company's current headcount band.
                        type: number
                      foundedYear:
                        description: Founding year.
                        type: number
                      headquarters:
                        description: >-
                          Headquarters as one address line (`city, state,
                          country`).
                        type: string
                      offices:
                        type: array
                        items:
                          type: string
                        description: >-
                          Other office locations, one address line each; not the
                          headquarters.
                      revenueStart:
                        description: Lower end of the annual revenue band, in USD.
                        type: number
                      revenueEnd:
                        description: Upper end of the annual revenue band, in USD.
                        type: number
                    required:
                      - offices
                  lastUpdated:
                    description: Date the profile data was last refreshed (`YYYY-MM-DD`).
                    type: string
                required:
                  - providerId
                  - departments
                  - subDepartments
                  - functions
                  - positions
              description: >-
                The first page of the people matched, masked; there is no
                further page. Values are verbatim, never formatted; an absent
                field means nothing is known.
            grossTotal:
              description: >-
                How many people matched the query when the preview ran: the
                number matched, not a count of new prospects and not a limit an
                import checks. Absent when the total is not available.
              type: number
          description: >-
            The first page of the people matched, masked, and how many people
            match in total.
          required:
            - people
        message:
          type: string
          description: Success message
          examples:
            - Operation completed successfully
      required:
        - status
        - data
        - message
    ClientApiErrorResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
          enum:
            - error
        data:
          type: object
          description: Response data
          example: null
          nullable: true
        message:
          type: string
          description: Error message
          example: An error occurred while processing the request
      required:
        - status
        - data
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````

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