openapi: 3.2.0
info:
  title: Gtm Linkedin Auto Scrape Runs API
  version: '1.0'
  contact:
    name: GTM API
    url: https://gtm-api.com
    email: support@gtm-api.com
  license:
    name: Proprietary
    url: https://gtm-api.com/license
  description: 'Operations tagged linkedin_auto_scrape_runs across 2 of this provider''s published API definitions: gtm-api-openapi-openapi.yml, gtm-api-linkedin-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.gtm-api.com/linkedin/v4
  description: Production, through the app.gtm-api.com gateway
security:
- BearerJwt: []
  TeamSid: []
tags:
- name: linkedin_auto_scrape_runs
  description: Registry package `mcp.linkedin/linkedin_auto_scrape_runs`, served on MCP mount `linkedin.auto-scrapes`.
paths:
  /api/linkedin-auto-scrape-runs/search:
    post:
      operationId: search_linkedin_auto_scrape_runs
      summary: Search LinkedIn auto-scrape runs
      description: 'List executions of the collectors: one row per pass of one auto-scrape page loop, with its page progress and its delta (new_count, seen_count, enrolled_count). Use for: the history of one job (filter linkedin_auto_scrape_sid, sort run_number desc, page_size 1 for the latest), why collection stopped (status failed, then read error_message), which runs produced (sort new_count desc), and which fed a mass-action (mass_action_sid). NOT for the leads themselves (search_linkedin_auto_scrape_results on first_seen_run_sid) and NOT for starting a run (run_linkedin_auto_scrape_now): runs are server-minted and immutable. No q, no include[]. run_number needs its parent partner (422 bounded_scan_required). Sort: created_at (default desc) | run_number | completed_at | new_count.


        Contract:

        - MCP tool `search_linkedin_auto_scrape_runs`, registry package `mcp.linkedin/linkedin_auto_scrape_runs`, mount `linkedin.auto-scrapes`.

        - Operation `search`, response envelope `search`.

        - Flags: read only.'
      tags:
      - linkedin_auto_scrape_runs
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchLinkedinAutoScrapeRunsRequest'
      responses:
        '200':
          description: '`search` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchLinkedinAutoScrapeRunsResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
      x-gtm-mcp-tool: search_linkedin_auto_scrape_runs
      x-gtm-mcp-mount: linkedin.auto-scrapes
      x-gtm-entity: linkedin_auto_scrape_runs
      x-gtm-operation: search
      x-gtm-envelope: search
      x-gtm-availability: ga
      x-gtm-dangerous: false
      x-gtm-mass-action: false
      x-gtm-step-eligible: false
      x-gtm-schedule-required: false
      x-gtm-tool-class: typical
    servers:
    - url: https://app.gtm-api.com/linkedin/v4
      description: Production, through the app.gtm-api.com gateway
  /api/linkedin-auto-scrape-runs/{sid}:
    get:
      operationId: get_linkedin_auto_scrape_run
      summary: Get LinkedIn auto-scrape run
      description: 'Fetch one run by sid: the poll handle after run_linkedin_auto_scrape_now. Read status, page_cursor and pages_applied for progress, new_count against enrolled_count for how much of the delta reached the linked mass-action, and error_message for why a failed run failed. The leads it discovered come from search_linkedin_auto_scrape_results filtered on first_seen_run_sid, which is the authoritative delta (new_count is a best-effort rollup under crash retry).


        Contract:

        - MCP tool `get_linkedin_auto_scrape_run`, registry package `mcp.linkedin/linkedin_auto_scrape_runs`, mount `linkedin.auto-scrapes`.

        - Operation `get`, response envelope `get`.

        - Flags: read only.'
      tags:
      - linkedin_auto_scrape_runs
      parameters:
      - name: sid
        in: path
        required: true
        description: Path segment `{sid}`.
        schema:
          type: string
          minLength: 18
          maxLength: 18
          pattern: ^ln_ar_
      - name: include[]
        in: query
        required: false
        description: Query parameter `include`.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: '`get` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLinkedinAutoScrapeRunResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
      x-gtm-mcp-tool: get_linkedin_auto_scrape_run
      x-gtm-mcp-mount: linkedin.auto-scrapes
      x-gtm-entity: linkedin_auto_scrape_runs
      x-gtm-operation: get
      x-gtm-envelope: get
      x-gtm-availability: ga
      x-gtm-dangerous: false
      x-gtm-mass-action: false
      x-gtm-step-eligible: false
      x-gtm-schedule-required: false
      x-gtm-tool-class: trivial
    servers:
    - url: https://app.gtm-api.com/linkedin/v4
      description: Production, through the app.gtm-api.com gateway
components:
  schemas:
    McpError:
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - validation_failed
              - nothing_to_update
              - not_found
              - relation_not_found
              - invalid_transition
              - limit_exceeded
              - payment_required
              - duplicate_rejected
              - conflict
              - delete_blocked
              - unauthorized
              - forbidden
              - rate_limited
              - internal_error
              - service_unavailable
              - not_implemented
            message:
              type: string
            recoverable:
              type: boolean
            suggestion:
              type: string
            field_errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    message:
                      type: string
                  required:
                  - rule
                  - message
            blockers:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    description: Machine-readable blocker type (active_flow, pending_tasks, …).
                  severity:
                    type: string
                    enum:
                    - hard
                    - soft
                    description: hard = external action required; soft = acknowledge is enough.
                  description:
                    type: string
                  entity_sid:
                    type:
                    - string
                    - 'null'
                  count:
                    type: integer
                  resolution:
                    type: string
                    description: 'Hard: tool name to call. Soft: code for acknowledge[].'
                  resolution_hint:
                    type: string
                required:
                - type
                - severity
                - description
                - entity_sid
                - resolution
                - resolution_hint
            context:
              type: object
              additionalProperties: {}
          required:
          - code
          - message
          - recoverable
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type:
              - string
              - 'null'
              description: The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends.
            actor_type:
              type:
              - string
              - 'null'
              description: user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends.
          required:
          - trace_id
          - span_id
          - timestamp
          - duration_ms
      required:
      - success
      - error
    SearchLinkedinAutoScrapeRunsRequest:
      type: object
      description: Request body of `search_linkedin_auto_scrape_runs`.
      properties:
        filter:
          type: object
          properties:
            sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
            linkedin_auto_scrape_sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
              description: 'Parent collector (ln_as_...). The dominant scope: one job history.'
            linkedin_account_sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
            mass_action_sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
                is_null:
                  type: boolean
              additionalProperties: false
              description: Which runs fed one mass-action. is_null:true = the run was minted collect-only.
            run_number:
              type: object
              properties:
                eq:
                  type: integer
                gte:
                  type: integer
                lte:
                  type: integer
                gt:
                  type: integer
                lt:
                  type: integer
              additionalProperties: false
              description: 'Requires a linkedin_auto_scrape_sid partner, else 422 bounded_scan_required: the ordinal is per parent.'
            trigger:
              type: object
              properties:
                eq:
                  type: string
                  enum:
                  - initial
                  - scheduled
                  - manual
                ne:
                  type: string
                  enum:
                  - initial
                  - scheduled
                  - manual
                in:
                  type: array
                  items:
                    type: string
                    enum:
                    - initial
                    - scheduled
                    - manual
                nin:
                  type: array
                  items:
                    type: string
                    enum:
                    - initial
                    - scheduled
                    - manual
              additionalProperties: false
            status:
              type: object
              properties:
                eq:
                  type: string
                  enum:
                  - pending
                  - in_progress
                  - completed
                  - failed
                ne:
                  type: string
                  enum:
                  - pending
                  - in_progress
                  - completed
                  - failed
                in:
                  type: array
                  items:
                    type: string
                    enum:
                    - pending
                    - in_progress
                    - completed
                    - failed
                nin:
                  type: array
                  items:
                    type: string
                    enum:
                    - pending
                    - in_progress
                    - completed
                    - failed
              additionalProperties: false
            new_count:
              type: object
              properties:
                eq:
                  type: integer
                gte:
                  type: integer
                lte:
                  type: integer
                gt:
                  type: integer
                lt:
                  type: integer
              additionalProperties: false
            enrolled_count:
              type: object
              properties:
                eq:
                  type: integer
                gte:
                  type: integer
                lte:
                  type: integer
                gt:
                  type: integer
                lt:
                  type: integer
              additionalProperties: false
            completed_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
                is_null:
                  type: boolean
              additionalProperties: false
            failed_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
                is_null:
                  type: boolean
              additionalProperties: false
            created_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
              additionalProperties: false
            updated_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
              additionalProperties: false
        include:
          type: array
          items:
            type: string
          description: Relations to eager-load (see entity Includes).
        sort:
          type: object
          properties:
            field:
              type: string
              enum:
              - created_at
              - run_number
              - completed_at
              - new_count
            direction:
              type: string
              enum:
              - asc
              - desc
              description: Default desc.
          required:
          - field
        page_size:
          type: integer
          minimum: 0
          maximum: 200
          description: 0..200, default 50. page_size=0 = count-only, page_size=1 = getFirst.
        cursor:
          type:
          - string
          - 'null'
          description: Opaque forward cursor from a previous response pagination.next_cursor.
    SearchLinkedinAutoScrapeRunsResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
          - true
        operation:
          type: string
          enum:
          - search
        items:
          type: array
          items:
            type: object
            properties:
              item:
                type: object
                properties:
                  sid:
                    type: string
                  team_sid:
                    type: string
                  linkedin_auto_scrape_sid:
                    type: string
                  linkedin_account_sid:
                    type: string
                  run_number:
                    type: number
                  trigger:
                    type: string
                    enum:
                    - initial
                    - scheduled
                    - manual
                  status:
                    type: string
                    enum:
                    - pending
                    - in_progress
                    - completed
                    - failed
                  page_cursor:
                    type: number
                  pages_applied:
                    type: number
                  results_seen:
                    type: number
                  new_count:
                    type: number
                  seen_count:
                    type: number
                  enrolled_count:
                    type: number
                  mass_action_sid:
                    type:
                    - string
                    - 'null'
                  completed_at:
                    type:
                    - string
                    - 'null'
                  failed_at:
                    type:
                    - string
                    - 'null'
                  error_message:
                    type:
                    - string
                    - 'null'
                  created_at:
                    type: string
                  updated_at:
                    type: string
                required:
                - sid
                - team_sid
                - linkedin_auto_scrape_sid
                - linkedin_account_sid
                - run_number
                - trigger
                - status
                - page_cursor
                - pages_applied
                - results_seen
                - new_count
                - seen_count
                - enrolled_count
                - mass_action_sid
                - completed_at
                - failed_at
                - error_message
                - created_at
                - updated_at
              included:
                type: object
                additionalProperties: {}
            required:
            - item
            - included
        pagination:
          type: object
          properties:
            next_cursor:
              type:
              - string
              - 'null'
            has_more:
              type: boolean
            total_count:
              type:
              - integer
              - 'null'
          required:
          - next_cursor
          - has_more
          - total_count
        applied_filters:
          type: object
          additionalProperties: {}
        includes:
          type: array
          items:
            type: string
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type:
              - string
              - 'null'
              description: The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends.
            actor_type:
              type:
              - string
              - 'null'
              description: user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends.
          required:
          - trace_id
          - span_id
          - timestamp
          - duration_ms
        counts:
          type: object
          properties: {}
      required:
      - success
      - operation
      - items
      - pagination
      - applied_filters
      - includes
      - meta
    GetLinkedinAutoScrapeRunResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
          - true
        operation:
          type: string
          enum:
          - get
        item:
          type: object
          properties:
            sid:
              type: string
            team_sid:
              type: string
            linkedin_auto_scrape_sid:
              type: string
            linkedin_account_sid:
              type: string
            run_number:
              type: number
            trigger:
              type: string
              enum:
              - initial
              - scheduled
              - manual
            status:
              type: string
              enum:
              - pending
              - in_progress
              - completed
              - failed
            page_cursor:
              type: number
            pages_applied:
              type: number
            results_seen:
              type: number
            new_count:
              type: number
            seen_count:
              type: number
            enrolled_count:
              type: number
            mass_action_sid:
              type:
              - string
              - 'null'
            completed_at:
              type:
              - string
              - 'null'
            failed_at:
              type:
              - string
              - 'null'
            error_message:
              type:
              - string
              - 'null'
            created_at:
              type: string
            updated_at:
              type: string
          required:
          - sid
          - team_sid
          - linkedin_auto_scrape_sid
          - linkedin_account_sid
          - run_number
          - trigger
          - status
          - page_cursor
          - pages_applied
          - results_seen
          - new_count
          - seen_count
          - enrolled_count
          - mass_action_sid
          - completed_at
          - failed_at
          - error_message
          - created_at
          - updated_at
        included:
          type: object
          additionalProperties: {}
        includes:
          type: array
          items:
            type: string
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type:
              - string
              - 'null'
              description: The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends.
            actor_type:
              type:
              - string
              - 'null'
              description: user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends.
          required:
          - trace_id
          - span_id
          - timestamp
          - duration_ms
      required:
      - success
      - operation
      - item
      - included
      - includes
      - meta
  responses:
    McpServerError:
      description: MCP error envelope with `error.code` internal_error or service_unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
    McpClientError:
      description: MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
  securitySchemes:
    BearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by gtm.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative.
    TeamSid:
      type: apiKey
      in: header
      name: Team-SID
      description: Team scope for tokens that do not carry one. Ignored when the token already names a team.
x-refined-from:
- gtm-api-openapi-openapi.yml
- gtm-api-linkedin-openapi.yaml