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

# Get Extractor Campaign Status

> Get the current status and progress of a lead extraction campaign

Returns the current status and progress of a lead extraction campaign.

## Request

<ParamField header="X-API-Key" type="string" required>
  Your API key
</ParamField>

## Path Parameters

<ParamField path="id" type="string" required>
  The campaign ID returned from the create campaign endpoint
</ParamField>

## Response

<ResponseField name="id" type="string">
  Unique identifier for the campaign
</ResponseField>

<ResponseField name="name" type="string">
  Name of the campaign
</ResponseField>

<ResponseField name="status" type="string">
  Current status: `PENDING`, `RUNNING`, `FINISHED`, `FAILED`
</ResponseField>

<ResponseField name="progress" type="object">
  <Expandable title="properties">
    <ResponseField name="extracted" type="number">
      Number of leads extracted so far
    </ResponseField>

    <ResponseField name="enriched" type="number">
      Number of leads enriched (if enrichment enabled)
    </ResponseField>

    <ResponseField name="requested" type="number">
      Number of leads requested (your limit)
    </ResponseField>

    <ResponseField name="percent_complete" type="number">
      Percentage complete (0-100)
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="created_at" type="string">
  ISO 8601 timestamp when the campaign was created
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.sendpilot.ai/v1/lead-extractor/campaigns/camp_abc123xyz/status" \
    -H "X-API-Key: your-api-key"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "camp_abc123xyz",
    "name": "Tech Startup Founders",
    "status": "RUNNING",
    "progress": {
      "extracted": 75,
      "enriched": 70,
      "requested": 100,
      "percent_complete": 75
    },
    "created_at": "2024-02-24T10:30:00.000Z"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /v1/lead-extractor/campaigns/{id}/status
openapi: 3.0.0
info:
  title: SendPilot External API
  description: >
    The SendPilot API enables you to programmatically manage LinkedIn outreach
    campaigns,

    add leads, update lead statuses, send messages, and receive real-time
    webhook notifications.
  version: 1.0.0
  contact:
    name: SendPilot Support
    email: support@sendpilot.ai
    url: https://sendpilot.ai
servers:
  - url: https://api.sendpilot.ai
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Credits
    description: Credits and quota management
  - name: Campaigns
    description: Campaign management endpoints
  - name: Leads
    description: Lead management endpoints
  - name: Lead Database
    description: Lead Database search endpoints
  - name: Lead Extractor
    description: Lead extraction campaign endpoints
  - name: Inbox
    description: Direct messaging endpoints
paths:
  /v1/lead-extractor/campaigns/{id}/status:
    get:
      tags:
        - Lead Extractor
      summary: Get Extractor Campaign Status
      description: Returns the current status and progress of a lead extraction campaign
      operationId: getLeadExtractorCampaignStatus
      parameters:
        - name: id
          in: path
          required: true
          description: The campaign ID returned from the create campaign endpoint
          schema:
            type: string
      responses:
        '200':
          description: Campaign status and progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadExtractorCampaignStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    LeadExtractorCampaignStatus:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - RUNNING
            - FINISHED
            - FAILED
        progress:
          $ref: '#/components/schemas/LeadExtractorCampaignProgress'
        created_at:
          type: string
          format: date-time
      required:
        - id
        - status
    LeadExtractorCampaignProgress:
      type: object
      properties:
        extracted:
          type: integer
          description: Number of leads extracted so far
        enriched:
          type: integer
          description: Number of leads enriched (if enrichment enabled)
        requested:
          type: integer
          description: Number of leads requested (your limit)
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
    Error:
      type: object
      properties:
        statusCode:
          type: integer
        error:
          type: string
        code:
          type: string
        message:
          type: string
      required:
        - statusCode
        - message
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````