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

# Poll a bulk-delete job

> Returns the current status of an async bulk-delete job created by the
202 branch of `POST /v1/leads/bulk-delete`. Poll until `status` is a
terminal value (`completed`, `completed_with_skipped`, `failed`, or
`canceled`). Requires scope: `leads:read`.




## OpenAPI

````yaml /api-reference/openapi.json get /v1/leads/bulk-delete/{job_id}
openapi: 3.0.3
info:
  title: TopCalls Voice API
  description: >
    TopCalls Voice Gateway API for creating and managing AI-powered phone calls.


    ## Authentication


    All API requests require authentication. Include your API key in the
    `Authorization` header:


    ```

    Authorization: Bearer tc_live_xxxxx

    ```


    ## Rate Limits


    Direct call creation via `POST /v1/calls` is limited to your account's

    `max_calls_per_minute` setting (default: 20) per minute. Exceeding it
    returns

    `429 Too Many Requests` with a `Retry-After` header.

    All endpoints are additionally subject to a flat limit of 120 requests per

    minute per account (all methods).


    On a `429`, wait for the number of seconds in the `Retry-After` header, then

    retry the same request. For automated clients, back off progressively on

    repeated `429`s. Limits are per account and are shared by all API keys.


    ## Error Format


    All errors follow RFC 7807 Problem+JSON format:


    ```json

    {
      "type": "https://api.topcalls.ai/errors/insufficient_quota",
      "title": "Insufficient Quota",
      "status": 402,
      "detail": "You need 5 minutes but have 3.5 remaining"
    }

    ```
  version: 1.0.0
  contact:
    name: TopCalls Support
    url: https://topcalls.ai
  license:
    name: Proprietary
servers:
  - url: https://api.topcalls.ai
    description: Production
security: []
tags:
  - name: Calls
    description: Create and manage phone calls
  - name: Phone Numbers
    description: Manage phone numbers and carriers
  - name: Account
    description: Account information and usage
  - name: Webhooks
    description: Webhook configuration and events
  - name: Configuration
    description: Available AI models, voices, and platform capabilities
paths:
  /v1/leads/bulk-delete/{job_id}:
    get:
      summary: Poll a bulk-delete job
      description: |
        Returns the current status of an async bulk-delete job created by the
        202 branch of `POST /v1/leads/bulk-delete`. Poll until `status` is a
        terminal value (`completed`, `completed_with_skipped`, `failed`, or
        `canceled`). Requires scope: `leads:read`.
      parameters:
        - name: job_id
          in: path
          required: true
          description: Bulk-delete job UUID, returned as `job_id` by the 202 response.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Job status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadDeleteJob'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Job not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth: []
components:
  schemas:
    LeadDeleteJob:
      type: object
      description: >-
        Status of an async bulk-delete job (`POST /v1/leads/bulk-delete` 202
        branch).
      required:
        - job_id
        - status
        - total_leads
        - deleted
        - skipped
        - chunks_done
        - chunks_total
        - error
        - created_at
        - started_at
        - completed_at
      properties:
        job_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - completed_with_skipped
            - failed
            - canceled
        total_leads:
          type: integer
          description: Number of leads the job matched at intake time.
        deleted:
          type: integer
          description: Number of leads deleted so far.
        skipped:
          type: integer
          description: >-
            Number of leads skipped (e.g. already deleted, cross-account
            filtered).
        chunks_done:
          type: integer
          description: Number of 1000-row chunks the worker has drained.
        chunks_total:
          type: integer
          description: Total number of chunks the job was split into.
        error:
          type: string
          nullable: true
          description: Error message if the job failed. Null otherwise.
        created_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
    Problem:
      type: object
      required:
        - status
        - title
      properties:
        type:
          type: string
          format: uri
          description: Error type URI
        title:
          type: string
          description: Error title
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Human-readable error detail
        code:
          type: string
          description: >
            Machine-readable error code for programmatic handling. Present on

            errors that carry a stable identifier (e.g. `PROMPT_SAFETY_FRAUD`,

            `job_not_found`, `too_many_ids`, `no_matches`). Distinct from the

            per-field `errors[].code` used for validation failures. Scenario-

            specific — see each endpoint's response examples for the exact
            value.
        instance:
          type: string
          format: uuid
          description: Request instance ID
        errors:
          type: array
          description: Validation errors (for 400 responses)
          items:
            type: object
            properties:
              path:
                type: string
                description: Field path (e.g., "phone_number", "metadata.from_number")
              message:
                type: string
                description: Error message
              code:
                type: string
                description: Error code (e.g., "invalid_string", "custom")
        details:
          type: string
          description: Additional error details (for provider errors)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Use `Authorization: Bearer tc_live_xxxxx`

````