> ## Documentation Index > Fetch the complete documentation index at: https://docs.gtm-api.com/llms.txt > Use this file to discover all available pages before exploring further. # Create LinkedIn auto-scrape > Save a scraping source as a collector and start it. Give the source EXACTLY one way: a bare url (people and company searches only) or the pair source_method plus source_input. Anything else is 422. Use for the standing ask, "keep pulling everyone behind this link". To wire outreach, author the plan FIRST on the mass-actions mount (preview_mass_action, then create_mass_action with scope kind none) and pass its ma_ac_ sid here: every new lead is appended to that run as one item. Omit mass_action_sid to collect only, omit replay_frequency for a one-shot. Run 1 dispatches AT ONCE: real LinkedIn automation starts, and a linked run begins enrolling. Watch it with search_linkedin_auto_scrape_runs, read the leads with search_linkedin_auto_scrape_results. Rejections are all pre-flight 422: invalid_url, invalid_source_method, method_not_available, source_input_incomplete, account_not_in_team, sales_nav_required (sales-nav sources and company-decision-makers need Sales Navigator), mass_action_incompatible. Contract: - MCP tool `create_linkedin_auto_scrape`, registry package `mcp.linkedin/linkedin_auto_scrapes`, mount `linkedin.auto-scrapes`. - Operation `create`, response envelope `create`. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API. ## OpenAPI ````yaml /api-reference/linkedin/openapi.yaml post /api/linkedin-auto-scrapes openapi: 3.0.3 info: title: 'GTM API public contract: gtm.service.linkedin' description: >- Connected LinkedIn accounts and everything driven through them: account health and smart limits, conversations and messages, the connection graph, outbound posting, scraping, profile and company enrichment, and the antidetect browsers that execute it all. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gtm.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gtm.service.linkedin`, 150 operations. Internal (`/internal`) and health endpoints are deliberately absent; the code-faithful spec that documents those lives in `product/openapi/gtm.openapi.tech`. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. 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 servers: - url: https://app.gtm-api.com/linkedin/v4 description: Production, through the app.gtm-api.com gateway - url: http://localhost:8020 description: Local Docker (gtm_linkedin_nginx_dev) security: - BearerJwt: [] TeamSid: [] tags: - name: antidetect_browser_logs description: >- Registry package `mcp.linkedin/antidetect_browser_logs`, served on MCP mount `linkedin.browsers`. - name: antidetect_browser_proxies description: >- Registry package `mcp.linkedin/antidetect_browser_proxies`, served on MCP mount `linkedin.browsers`. - name: antidetect_browsers description: >- Registry package `mcp.linkedin/antidetect_browsers`, served on MCP mount `linkedin.browsers`. - name: cloud_browser_sessions description: >- Registry package `mcp.linkedin/cloud_browser_sessions`, served on MCP mount `linkedin.browsers`. - name: cloud_browsers description: >- Registry package `mcp.linkedin/cloud_browsers`, served on MCP mount `linkedin.browsers`. - name: data_requests description: >- Registry package `mcp.linkedin/data_requests`, served on MCP mount `linkedin.data`. - name: linkedin_account_activity_log description: >- Registry package `mcp.linkedin/linkedin_account_activity_log`, served on MCP mount `linkedin.account-monitor`. - name: linkedin_account_block_log description: >- Registry package `mcp.linkedin/linkedin_account_block_log`, served on MCP mount `linkedin.account-monitor`. - name: linkedin_account_quota_hits description: >- Registry package `mcp.linkedin/linkedin_account_quota_hits`, served on MCP mount `linkedin.account-monitor`. - name: linkedin_account_smart_limits description: >- Registry package `mcp.linkedin/linkedin_account_smart_limits`, served on MCP mount `linkedin.accounts`. - name: linkedin_account_snapshots description: >- Registry package `mcp.linkedin/linkedin_account_snapshots`, served on MCP mount `linkedin.account-monitor`. - name: linkedin_account_sync_runs description: >- Registry package `mcp.linkedin/linkedin_account_sync_runs`, served on MCP mount `linkedin.account-monitor`. - name: linkedin_accounts description: >- Registry package `mcp.linkedin/linkedin_accounts`, served on MCP mount `linkedin.accounts`. - name: linkedin_auto_scrape_results description: >- Registry package `mcp.linkedin/linkedin_auto_scrape_results`, served on MCP mount `linkedin.auto-scrapes`. - name: linkedin_auto_scrape_runs description: >- Registry package `mcp.linkedin/linkedin_auto_scrape_runs`, served on MCP mount `linkedin.auto-scrapes`. - name: linkedin_auto_scrapes description: >- Registry package `mcp.linkedin/linkedin_auto_scrapes`, served on MCP mount `linkedin.auto-scrapes`. - name: linkedin_benchmarks description: >- Registry package `mcp.linkedin/linkedin_benchmarks`, served on MCP mount `linkedin.account-monitor`. - name: linkedin_connection_invitations description: >- Registry package `mcp.linkedin/linkedin_connection_invitations`, served on MCP mount `linkedin.network`. - name: linkedin_connection_requests description: >- Registry package `mcp.linkedin/linkedin_connection_requests`, served on MCP mount `linkedin.network`. - name: linkedin_connections description: >- Registry package `mcp.linkedin/linkedin_connections`, served on MCP mount `linkedin.network`. - name: linkedin_conversations description: >- Registry package `mcp.linkedin/linkedin_conversations`, served on MCP mount `linkedin.messaging`. - name: linkedin_custom_requests description: >- Registry package `mcp.linkedin/linkedin_custom_requests`, served on MCP mount `linkedin.platform`. - name: linkedin_enrichment description: >- Registry package `mcp.linkedin/linkedin_enrichment`, served on MCP mount `linkedin.enrichment`. - name: linkedin_followers description: >- Registry package `mcp.linkedin/linkedin_followers`, served on MCP mount `linkedin.network`. - name: linkedin_messages description: >- Registry package `mcp.linkedin/linkedin_messages`, served on MCP mount `linkedin.messaging`. - name: linkedin_posting description: >- Registry package `mcp.linkedin/linkedin_posting`, served on MCP mount `linkedin.content`. - name: linkedin_scraping description: >- Registry package `mcp.linkedin/linkedin_scraping`, served on MCP mount `linkedin.scraping`. paths: /api/linkedin-auto-scrapes: post: tags: - linkedin_auto_scrapes summary: Create LinkedIn auto-scrape description: >- Save a scraping source as a collector and start it. Give the source EXACTLY one way: a bare url (people and company searches only) or the pair source_method plus source_input. Anything else is 422. Use for the standing ask, "keep pulling everyone behind this link". To wire outreach, author the plan FIRST on the mass-actions mount (preview_mass_action, then create_mass_action with scope kind none) and pass its ma_ac_ sid here: every new lead is appended to that run as one item. Omit mass_action_sid to collect only, omit replay_frequency for a one-shot. Run 1 dispatches AT ONCE: real LinkedIn automation starts, and a linked run begins enrolling. Watch it with search_linkedin_auto_scrape_runs, read the leads with search_linkedin_auto_scrape_results. Rejections are all pre-flight 422: invalid_url, invalid_source_method, method_not_available, source_input_incomplete, account_not_in_team, sales_nav_required (sales-nav sources and company-decision-makers need Sales Navigator), mass_action_incompatible. Contract: - MCP tool `create_linkedin_auto_scrape`, registry package `mcp.linkedin/linkedin_auto_scrapes`, mount `linkedin.auto-scrapes`. - Operation `create`, response envelope `create`. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API. operationId: create_linkedin_auto_scrape requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateLinkedinAutoScrapeRequest' responses: '200': description: '`create` success envelope.' content: application/json: schema: $ref: '#/components/schemas/CreateLinkedinAutoScrapeResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: CreateLinkedinAutoScrapeRequest: type: object description: Request body of `create_linkedin_auto_scrape`. properties: linkedin_account_sid: type: string minLength: 18 maxLength: 18 pattern: ^ln_ac_ description: >- Executor LinkedIn account sid (ln_ac_...): whose browser paginates the source. title: type: string nullable: true maxLength: 255 description: >- Human label for the list view. Server derives "{result_kind} {source_method}" when omitted. url: type: string maxLength: 2048 description: >- LinkedIn or Sales Navigator people/company SEARCH url. Mutually exclusive with source_method plus source_input. source_method: type: string enum: - search-people-by-url - search-people-by-params - search-sales-nav-people-by-url - search-sales-nav-people-by-params - similar-profiles - company-employees - company-decision-makers - get-post-commenters - get-post-reactors - get-post-resharers - search-companies-by-url - search-companies-by-params - search-sales-nav-companies-by-url - search-sales-nav-companies-by-params - similar-companies description: >- The paginated verb to replay. Required (with source_input) for every non-search source. source_input: type: object additionalProperties: {} description: >- The verb's own arguments. One key is mandatory per family: url, filters, anchor_company_ln_id, anchor_nickname (similar-profiles takes the vanity slug, never a URN), or activity_urn. filters takes the SAME schema as the matching scrape_linkedin_search_*_by_params tool (see it for the facet vocabulary and typeahead workflow). replay_frequency: type: string nullable: true enum: - hourly - daily - weekly - monthly description: >- Cadence: hourly | daily | weekly | monthly. Omit or null for a one-shot job that runs once. mass_action_sid: type: string nullable: true minLength: 18 maxLength: 18 pattern: ^ma_ac_ description: >- Standing mass-action new leads enrol into. Cross-checked for same team, live, and target family compatible with result_kind. required: - linkedin_account_sid CreateLinkedinAutoScrapeResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - create item: type: object properties: sid: type: string team_sid: type: string linkedin_account_sid: type: string source_method: type: string enum: - search-people-by-url - search-people-by-params - search-sales-nav-people-by-url - search-sales-nav-people-by-params - similar-profiles - company-employees - company-decision-makers - get-post-commenters - get-post-reactors - get-post-resharers - search-companies-by-url - search-companies-by-params - search-sales-nav-companies-by-url - search-sales-nav-companies-by-params - similar-companies source_input: type: object additionalProperties: {} detected_platform: type: string enum: - linkedin - sales_navigator - recruiter result_kind: type: string enum: - person - company status: type: string enum: - active - paused consecutive_failures: type: number runs_count: type: number total_new_results: type: number title: type: string nullable: true replay_frequency: type: string nullable: true enum: - hourly - daily - weekly - monthly paused_reason: type: string nullable: true enum: - manual - too_many_failures - account_unavailable next_run_at: type: string nullable: true last_run_at: type: string nullable: true mass_action_sid: type: string nullable: true created_by: type: object nullable: true properties: actor_type: type: string enum: - user - support - api_key - system actor_sid: type: string nullable: true team_sid: type: string permissions: type: object additionalProperties: {} request_sid: type: string nullable: true reason: type: string nullable: true required: - actor_type - actor_sid - team_sid - permissions deleted_by: type: object nullable: true properties: actor_type: type: string enum: - user - support - api_key - system actor_sid: type: string nullable: true team_sid: type: string permissions: type: object additionalProperties: {} request_sid: type: string nullable: true reason: type: string nullable: true required: - actor_type - actor_sid - team_sid - permissions created_at: type: string updated_at: type: string deleted_at: type: string nullable: true required: - sid - team_sid - linkedin_account_sid - source_method - source_input - detected_platform - result_kind - status - consecutive_failures - runs_count - total_new_results - title - replay_frequency - paused_reason - next_run_at - last_run_at - mass_action_sid - created_by - deleted_by - created_at - updated_at - deleted_at already_exists: type: boolean 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. debug_url: type: string description: Deep link to the post-call analysis UI. required: - trace_id - span_id - timestamp - duration_ms - debug_url required: - success - operation - item - already_exists - meta 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: anyOf: - type: string - 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 nullable: true 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. debug_url: type: string description: Deep link to the post-call analysis UI. required: - trace_id - span_id - timestamp - duration_ms - debug_url required: - success - error responses: 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' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. 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. ````