> ## 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. # Scrape Sales Navigator companies by params > Structured-filter form of the SN account search, carrying the COMPLETE node vocabulary (15 members) - the one engine that filters on annual revenue (range, in millions), company AND per-department headcount growth (ranges, percent), department headcount, follower buckets, Fortune tier, buying signals (leadership changes / funding events), hiring status, 1st-degree relationship, saved accounts and account lists. Typeahead facet ids come from scrape_linkedin_sales_nav_param_id_lookup (type named per member); static-enum members carry their full id sets inline; exclude: true negates a typeahead value. SN-capable executor required. Cost 2 credits. Contract: - MCP tool `scrape_linkedin_search_sales_nav_companies_by_params`, registry package `mcp.linkedin/linkedin_scraping`, mount `linkedin.scraping`. - Operation `action`, response envelope `action`. - Flags: creditable: the response carries a `credits` block and the call can debit the team ledger. ## OpenAPI ````yaml /api-reference/linkedin/openapi.yaml post /api/linkedin-scraping/search-sales-nav-companies-by-params 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-scraping/search-sales-nav-companies-by-params: post: tags: - linkedin_scraping summary: Scrape Sales Navigator companies by params description: >- Structured-filter form of the SN account search, carrying the COMPLETE node vocabulary (15 members) - the one engine that filters on annual revenue (range, in millions), company AND per-department headcount growth (ranges, percent), department headcount, follower buckets, Fortune tier, buying signals (leadership changes / funding events), hiring status, 1st-degree relationship, saved accounts and account lists. Typeahead facet ids come from scrape_linkedin_sales_nav_param_id_lookup (type named per member); static-enum members carry their full id sets inline; exclude: true negates a typeahead value. SN-capable executor required. Cost 2 credits. Contract: - MCP tool `scrape_linkedin_search_sales_nav_companies_by_params`, registry package `mcp.linkedin/linkedin_scraping`, mount `linkedin.scraping`. - Operation `action`, response envelope `action`. - Flags: creditable: the response carries a `credits` block and the call can debit the team ledger. operationId: scrape_linkedin_search_sales_nav_companies_by_params requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/ScrapeLinkedinSearchSalesNavCompaniesByParamsRequest responses: '200': description: '`action` success envelope.' content: application/json: schema: $ref: >- #/components/schemas/ScrapeLinkedinSearchSalesNavCompaniesByParamsResponse 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: ScrapeLinkedinSearchSalesNavCompaniesByParamsRequest: type: object description: Request body of `scrape_linkedin_search_sales_nav_companies_by_params`. properties: linkedin_account_sid: type: string nullable: true minLength: 18 maxLength: 18 pattern: ^ln_ac_ description: >- Preferred executor account (ln_ac_…). OPTIONAL everywhere on this surface: omitted → platform pool + credits (reason infra_pool); given with scraping-bucket budget → own account, charged 0; given but the bucket is saturated/held → automatic pool fallback (reason limit_fallback), never a 429 (§9.5). idempotency_key: type: string nullable: true maxLength: 128 description: >- Ledger replay guard: a repeat call with the same (team, key) returns the stored outcome; no re-execution, no double charge. Recommended on every paid call. filters: type: object properties: keywords: type: string nullable: true maxLength: 256 company_headquarters: type: array nullable: true items: type: object properties: id: type: string nullable: true maxLength: 128 description: >- Opaque SN facet id, VERBATIM from scrape_linkedin_sales_nav_param_id_lookup. text: type: string nullable: true maxLength: 256 description: >- Free-text label - SN matches it server-side; use when no id is at hand. exclude: type: boolean nullable: true description: >- true → EXCLUDED (negative filter); omitted/false → INCLUDED. description: 'One facet value: at least one of id / text.' maxItems: 10 description: >- HQ region. Ids via lookup(type: "BING_GEO"); exclude supported (e.g. exclude APAC). industries: type: array nullable: true items: type: object properties: id: type: string nullable: true maxLength: 128 description: >- Opaque SN facet id, VERBATIM from scrape_linkedin_sales_nav_param_id_lookup. text: type: string nullable: true maxLength: 256 description: >- Free-text label - SN matches it server-side; use when no id is at hand. exclude: type: boolean nullable: true description: >- true → EXCLUDED (negative filter); omitted/false → INCLUDED. description: 'One facet value: at least one of id / text.' maxItems: 10 description: 'Industries. Ids via lookup(type: "INDUSTRY").' account_lists: type: array nullable: true items: type: object properties: id: type: string nullable: true maxLength: 128 description: >- Opaque SN facet id, VERBATIM from scrape_linkedin_sales_nav_param_id_lookup. text: type: string nullable: true maxLength: 256 description: >- Free-text label - SN matches it server-side; use when no id is at hand. exclude: type: boolean nullable: true description: >- true → EXCLUDED (negative filter); omitted/false → INCLUDED. description: 'One facet value: at least one of id / text.' maxItems: 10 description: >- Your SN account lists. Ids via lookup(type: "ACCOUNT_LIST") - numeric list ids or the "ALL" sentinel; exclude: true skips a list (e.g. current book of business). company_headcounts: type: array nullable: true items: type: string enum: - B - C - D - E - F - G - H - I maxItems: 10 description: >- Company size: 'B' 1-10, 'C' 11-50, 'D' 51-200, 'E' 201-500, 'F' 501-1000, 'G' 1001-5000, 'H' 5001-10000, 'I' 10001+ (account search has no 'A'). num_of_followers: type: array nullable: true items: type: string enum: - NFR1 - NFR2 - NFR3 - NFR4 - NFR5 maxItems: 5 description: >- LinkedIn page followers: NFR1 1-50, NFR2 51-100, NFR3 101-1000, NFR4 1001-5000, NFR5 5001+. fortune: type: array nullable: true items: type: string enum: - '1' - '2' - '3' - '4' maxItems: 4 description: >- Fortune 500 tier: '1' Fortune 50, '2' 51-100, '3' 101-250, '4' 251-500. account_activities: type: array nullable: true items: type: string enum: - SLC - RFE maxItems: 2 description: >- Buying signals: 'SLC' senior-leadership changes in the last 3 months, 'RFE' funding event in the past 12 months. annual_revenue: type: object nullable: true properties: min: type: integer minimum: 0 maximum: 100000000 max: type: integer minimum: 0 maximum: 100000000 currency: type: string nullable: true pattern: ^[A-Z]{3}$ description: ISO-4217 code; default USD. required: - min - max description: >- Annual revenue range in MILLIONS (e.g. {min: 10, max: 100} = $10M-$100M). company_headcount_growth: type: object nullable: true properties: min: type: integer minimum: -100 maximum: 1000 max: type: integer minimum: -100 maximum: 1000 required: - min - max description: >- Company-wide headcount growth range, percent (negative = shrinking). department_headcount: type: object nullable: true properties: department: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' description: >- Numeric SN department id - the same taxonomy as the people-search functions facet (see its legend, or lookup(type: "FUNCTION")). min: type: integer minimum: 0 maximum: 1000000 max: type: integer minimum: 0 maximum: 1000000 required: - department - min - max description: >- Headcount of ONE department (e.g. department "25" Sales, {min: 20, max: 99999}). department_headcount_growth: type: object nullable: true properties: department: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' description: >- Numeric SN department id - the same taxonomy as the people-search functions facet (see its legend, or lookup(type: "FUNCTION")). min: type: integer minimum: -100 maximum: 1000 max: type: integer minimum: -100 maximum: 1000 required: - department - min - max description: >- Growth of ONE department, percent - e.g. engineering team growing 10%+. hiring_on_linkedin: type: boolean nullable: true description: true → only accounts currently hiring on LinkedIn. first_degree_connection: type: boolean nullable: true description: true → only accounts where you have a 1st-degree connection. saved_accounts_only: type: boolean nullable: true description: true → only your saved SN accounts. description: >- Sales Navigator account-search filters - the COMPLETE SN vocabulary. At least one member must be non-empty (a false toggle counts as empty). lookup = scrape_linkedin_sales_nav_param_id_lookup. page: type: integer minimum: 1 maximum: 100 description: Default 1. required: - filters ScrapeLinkedinSearchSalesNavCompaniesByParamsResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - action action: type: string description: kebab-case verb; matches the route segment. item: {} result: type: object properties: rows: type: array items: type: object properties: company_ln_id: type: string nullable: true nickname: type: string nullable: true name: type: string nullable: true industry: type: string nullable: true employees_size: type: string nullable: true followers: type: integer nullable: true location: type: string nullable: true tagline: type: string nullable: true logo_url: type: string nullable: true website: type: string nullable: true required: - company_ln_id - nickname - name - industry - employees_size - followers - location - tagline - logo_url - website description: >- The transient result list, in LinkedIn’s order; NOTHING persisted. paging: type: object properties: page: type: integer page_size: type: integer has_more: type: boolean total: type: integer nullable: true required: - page - page_size - has_more - total description: 'Page-numbered paging: re-call with page + 1 while has_more.' data_request: type: object properties: {} description: >- The kind="scrape" data_requests ledger row for this call (terminal completed), embedded as result.data_request; served_from_cache always false. Full DataRequestDomain shape owned by ./data_requests.md, so it is left passthrough here. required: - rows - paging - data_request 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 credits: type: object properties: charged: type: integer minimum: 0 description: Credits debited for THIS call (0 on own-account / cache hit). reason: type: string nullable: true enum: - infra_pool - limit_fallback executed_on: type: string enum: - own_account - infra_pool balance_after: type: integer nullable: true minimum: 0 description: >- Team balance after the debit; null when the ledger was untouched. required: - charged - reason - executed_on - balance_after required: - success - operation - action - item - result - 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. ````