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

# Scrape a LinkedIn Sales Navigator search

> Starts an async Sales Navigator people-search scrape, 1 credit per scraped lead. limit is optional; without it a Sales Navigator search scrapes every match and a classic people search scrapes up to 2500. Set enrichFirstN with enrichEmail/enrichPhone to also enrich the first N scraped leads. Supports idempotency via Idempotency-Key header (a job with the same key for this account returns the existing job). Supports webhook notifications via webhookURL (POST JSON on completion/failure). Webhook payload: jobID (string), status (completed|failed), listID (string), scraped (int).



## OpenAPI

````yaml https://api.leadsforge.ai/public/swagger/doc.json post /salesnav/jobs
openapi: 3.1.0
info:
  description: >-
    Search B2B leads, find their work emails, phone numbers and LinkedIn
    profiles, and discover lookalike companies, company page followers and local
    businesses.


    Authenticate every request with your API key in the `Authorization` header:
    the raw key, no `Bearer` prefix. Create the key in the Leadsforge app under
    Settings -> API & MCP.


    Paid operations consume credits from your account balance, and each
    operation says whether it is paid. Long-running operations are asynchronous:
    they return a job that you poll (or receive by webhook) and then page
    through its results.


    Errors return a JSON body with a human-readable `message` and, except for an
    unknown path (404), a stable `code`. Program against `code`. A JSON body
    with a field the operation does not accept is rejected with 400 bad_request,
    listing the unknown fields in data.validations. A request still running when
    the server timeout is reached is cut off with 503 and an empty body.
  license:
    name: Proprietary
    url: https://www.leadsforge.ai/terms
  termsOfService: https://www.leadsforge.ai/terms
  title: Leadsforge API
  version: '1.0'
servers:
  - url: https://api.leadsforge.ai/public/v1
security: []
tags:
  - description: Your account's credit balance.
    name: Balance
  - description: >-
      Find people by role, seniority, company, location and other filters.
      Searches and counts are free up to a monthly allowance, then each one
      costs credits; finding contact details is charged separately.
    name: Search
  - description: >-
      Accepted values for the controlled filters of POST /search and POST
      /search/count, and a resolver for location strings. All free.
    name: Search filters
  - description: >-
      Find work emails, phone numbers and LinkedIn profiles. Asynchronous jobs
      take up to 500 people; synchronous calls take one person and answer in the
      same response.
    name: Enrichment
  - description: >-
      Find companies similar to the domains you give. Previews are free up to a
      monthly allowance, then each one costs credits; the search consumes
      credits per company returned.
    name: Lookalikes
  - description: >-
      Find the people who follow a LinkedIn company page. Asynchronous jobs that
      consume credits per follower collected.
    name: Company followers
  - description: >-
      Find local businesses in an area you choose, then find their owners'
      emails and phone numbers. Both steps are asynchronous jobs that consume
      credits.
    name: Maps discovery
  - description: Scrape LinkedIn Sales Navigator searches.
    name: salesnav
externalDocs:
  description: Leadsforge API guides
  url: >-
    https://developer.salesforge.ai/leadsforge-api/concepts/search-and-enrichment
paths:
  /salesnav/jobs:
    post:
      tags:
        - salesnav
      summary: Scrape a LinkedIn Sales Navigator search
      description: >-
        Starts an async Sales Navigator people-search scrape, 1 credit per
        scraped lead. limit is optional; without it a Sales Navigator search
        scrapes every match and a classic people search scrapes up to 2500. Set
        enrichFirstN with enrichEmail/enrichPhone to also enrich the first N
        scraped leads. Supports idempotency via Idempotency-Key header (a job
        with the same key for this account returns the existing job). Supports
        webhook notifications via webhookURL (POST JSON on completion/failure).
        Webhook payload: jobID (string), status (completed|failed), listID
        (string), scraped (int).
      operationId: startSalesNavScrape
      parameters:
        - description: >-
            Idempotency key - if a job with this key already exists for this
            account, the existing job is returned as-is
          in: header
          name: Idempotency-Key
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSalesNavSearchRequest'
              description: Scrape request
              summary: body
        description: Scrape request
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesNavJobResponse'
          description: Job created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Unauthorized
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Insufficient credits
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Internal Server Error
      security:
        - ApiKeyAuth: []
components:
  schemas:
    StartSalesNavSearchRequest:
      properties:
        enrichEmail:
          example: true
          type: boolean
        enrichFirstN:
          example: 50
          minimum: 1
          type: integer
        enrichPhone:
          example: false
          type: boolean
        limit:
          example: 500
          minimum: 1
          type: integer
        salesnavUrl:
          example: https://www.linkedin.com/sales/search/people?keywords=cto
          type: string
        webhookURL:
          example: https://example.com/webhooks/salesnav
          type: string
      required:
        - salesnavUrl
      type: object
    SalesNavJobResponse:
      properties:
        completedAt:
          example: '2026-10-06T12:05:00Z'
          type: string
        contactsAdded:
          example: 1214
          type: integer
        createdAt:
          example: '2026-10-06T12:00:00Z'
          type: string
        creditsUsed:
          example: 2226
          type: number
        emailsFound:
          example: 312
          type: integer
        enrichEmail:
          example: true
          type: boolean
        enrichFirstN:
          example: 50
          type: integer
        enrichPhone:
          example: false
          type: boolean
        error:
          type: string
        jobID:
          example: a1b2c3d4-0000-0000-0000-000000000000
          type: string
        limit:
          example: 500
          type: integer
        listID:
          example: list_abc123
          type: string
        phonesFound:
          example: 0
          type: integer
        salesnavUrl:
          example: https://www.linkedin.com/sales/search/people?keywords=cto
          type: string
        scraped:
          example: 487
          type: integer
        skipped:
          example: 26
          type: integer
        status:
          enum:
            - pending
            - scraping
            - importing
            - enriching
            - exporting
            - completed
            - failed
          example: pending
          type: string
        statusURL:
          example: /public/v1/salesnav/jobs/a1b2c3d4
          type: string
        tags:
          items:
            type: string
          type: array
          uniqueItems: false
        updatedAt:
          example: '2026-10-06T12:01:00Z'
          type: string
        webhookURL:
          example: https://example.com/webhooks/salesnav
          type: string
      type: object
    ApiError:
      properties:
        code:
          description: >-
            Code is the stable, machine-readable error code; each endpoint lists
            the codes it returns.
          type: string
        data:
          description: >-
            Data carries details for some errors; on validation errors it is
            {"validations": ["..."]}, one message per

            invalid field.
        message:
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your API key, sent as is (no `Bearer` prefix). Create it in the
        Leadsforge app under Settings -> API & MCP.
      in: header
      name: Authorization
      type: apiKey

````

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