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

# People search

> Initiates a new lead search based on the provided parameters.

**Rate limit:** 1 request per second

## Scale Parameter

The `scale` parameter (boolean, optional) allows you to increase your volume of requests by omitting the following fields:

* `connections_count`
* `headline`
* Vanity LinkedIn profile URL (like `https://www.linkedin.com/in/mathieu-brun-picard/`)

When `scale` is set to `true`, you will still receive a LinkedIn profile URL, but it will use the user ID instead of the vanity URL format (like `https://linkedin.com/in/ACwAACaX8uYBfAh-5YxmfObz4mVOKYih3zxa-TM`).


## OpenAPI

````yaml POST /leads
openapi: 3.0.1
info:
  title: Pipecorn Accounts API
  description: Pipecorn Accounts API
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://app.pipecorn.com/api/v2/
security:
  - defaultApiKey: []
paths:
  /leads:
    post:
      summary: Create a new lead search
      description: |-
        Initiates a new lead search based on the provided parameters.

        **Rate limit:** 1 request per second
      requestBody:
        description: Lead search parameters
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewLeadSearch'
      responses:
        '202':
          description: Lead search initiated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: The ID of the created lead search
                  status:
                    type: string
                    enum:
                      - processing
                    description: The status of the lead search
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - API key doesn't have the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (1 request per second)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    NewLeadSearch:
      required:
        - search_url
        - name
      type: object
      properties:
        search_url:
          type: string
          format: uri
          description: The LinkedIn search URL to extract leads from
        webhook_url:
          type: string
          format: uri
          description: >-
            Optional webhook URL to receive notifications when the search is
            complete
        name:
          type: string
          description: Name of the lead search
        streaming:
          type: boolean
          description: >-
            When set to true, leads will be sent individually to the webhook_url
            as they are found. This is ideal for integration with platforms like
            Clay that process leads in real-time.
          default: false
          example: true
        custom:
          type: object
          description: >-
            Custom fields to include with the lead search that will be returned
            in the webhook (like crm id, etc.)
          additionalProperties: true
          example:
            hubspot_id: '134567'
        limit:
          type: integer
          description: >-
            Optional parameter to limit the number of results returned. If not
            specified, all matching leads will be returned.
          minimum: 1
          example: 100
        scale:
          type: boolean
          description: >-
            When set to true, increases request volume by omitting the following
            fields: connections_count, headline, and vanity LinkedIn profile
            URL. You will still receive a LinkedIn profile URL, but it will use
            the user ID instead of the vanity URL (e.g.,
            https://www.linkedin.com/in/mathieu-brun-picard/).
          default: false
          example: true
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    defaultApiKey:
      type: apiKey
      in: header
      description: Your API key
      name: X-API-KEY

````