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

# Stop a people search job

> Stop a running job. Pages already being fetched finish and are saved; no further page is bought. The job then ends as `stopped`, keeping what it saved. A job still planning cannot be stopped yet: 409, try again once it runs.



## OpenAPI

````yaml /reference/openapi.yaml post /v2/people/search-jobs/{JobID}/stop
openapi: 3.1.0
info:
  title: Tamtam Public API
  version: 2.0.0
servers:
  - url: https://api.tamtam.ai/api
security: []
paths:
  /v2/people/search-jobs/{JobID}/stop:
    post:
      tags:
        - People Search
      summary: Stop a people search job
      description: >-
        Stop a running job. Pages already being fetched finish and are saved; no
        further page is bought. The job then ends as `stopped`, keeping what it
        saved. A job still planning cannot be stopped yet: 409, try again once
        it runs.
      operationId: stop-people-search-job
      parameters:
        - description: The job ID returned when the job was created
          in: path
          name: JobID
          required: true
          schema:
            description: The job ID returned when the job was created
            examples:
              - b3c6f5e2-1234-4abc-9def-0123456789ab
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeopleSearchJobDto'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
        - apikeyAuth: []
        - bearerAuth: []
components:
  schemas:
    PeopleSearchJobDto:
      additionalProperties: false
      properties:
        contacts_list_ids:
          description: >-
            The contacts lists the job has filled so far, in order, 10,000
            people each. Empty when no list was asked for.
          items:
            type: string
          type:
            - array
            - 'null'
        created_at:
          description: When the job was created
          format: date-time
          type: string
        error:
          description: >-
            Why a failed job stopped: planning_failed, search_failed or
            start_failed
          examples:
            - planning_failed
          type: string
        finished_at:
          description: When the job ended, whatever the reason
          format: date-time
          type: string
        job_id:
          description: The job's ID, to poll it, read its results or stop it
          examples:
            - b3c6f5e2-1234-4abc-9def-0123456789ab
          type: string
        max_results:
          description: The cap the job stops at. 0 while planning.
          examples:
            - 100000
          format: int64
          type: integer
        plan:
          description: >-
            The searches the job was split into, in the order they run. Empty
            while planning.
          items:
            $ref: '#/components/schemas/PeopleSearchJobPlannedSearchDto'
          type:
            - array
            - 'null'
        provider:
          description: The source the job was pinned to, when one was asked for
          examples:
            - endor
          type: string
        saved_count:
          description: How many distinct people the job has saved so far
          examples:
            - 12500
          format: int64
          type: integer
        searches:
          description: >-
            How many searches the job was split into. 1 for a search the source
            serves whole.
          examples:
            - 24
          format: int64
          type: integer
        searches_failed:
          description: >-
            How many of those failed after repeated retries. What they saved
            before failing is kept.
          examples:
            - 0
          format: int64
          type: integer
        searches_finished:
          description: How many of those have run to their end
          examples:
            - 10
          format: int64
          type: integer
        status:
          description: >-
            planning while the search is split into searches the source can
            serve whole. planned once the plan is ready: a job started with the
            plan endpoint waits there until you run it, one started to run goes
            straight on. running while pages are collected. completed when every
            search ran to its end or max_results was reached. stopped when you
            stopped it. out_of_credits when the account ran out of credits.
            failed when it could not go on, see error. Whatever ends a job, what
            it saved is kept.
          enum:
            - planning
            - planned
            - running
            - completed
            - stopped
            - out_of_credits
            - failed
          examples:
            - running
          type: string
        unreachable_count:
          description: >-
            People the search matches that no split could bring within reach of
            the source, and that the job will therefore not collect. See the
            operation description.
          examples:
            - 0
          format: int64
          type: integer
      required:
        - job_id
        - status
        - max_results
        - saved_count
        - unreachable_count
        - searches
        - searches_finished
        - searches_failed
        - plan
        - contacts_list_ids
        - created_at
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    PeopleSearchJobPlannedSearchDto:
      additionalProperties: false
      properties:
        label:
          description: >-
            What this search is: the original search narrowed to one slice.
            Empty for a search that was not split.
          examples:
            - HR Manager · FR · 501-1000
          type: string
        result_count:
          description: >-
            How many people the source counts for this search. At most 2,500 are
            collected from it: a count above that is a slice no split could
            narrow, whose surplus is in unreachable_count. Absent when the
            source was not counted, for a search pinned to endor.
          examples:
            - 1840
          format: int64
          type: integer
      required:
        - label
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    apikeyAuth:
      description: Account API key passed in the Authorization header
      in: header
      name: Authorization
      type: apiKey
    bearerAuth:
      description: Bearer JWT obtained via the OAuth 2.1 authorization flow
      scheme: bearer
      type: http

````

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