> ## 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 group search

> One page of a LinkedIn GROUP search, the fifth row kind on this surface. `filters` carries keywords and nothing else, exactly like the events search, so a pasted /search/results/groups/ `url` is the only way to anything the groups screen offers beyond a keyword: send exactly one of the two. Rows are groups keyed by group_ln_id, with a /groups/ URL, the name, Public or Private, the member counter both as printed and parsed (0 is real, null is unread), a best-effort blurb and a logo. WARNING, the English dependency is TOTAL, worse than the jobs search: the name is read out of English UI copy and a card whose name cannot be read is dropped, so a non-English executor returns ZERO rows and still reports success. Page on with has_more, never on paging.total.

Contract:
- MCP tool `scrape_linkedin_search_groups`, registry package `mcp.linkedin/linkedin_scraping`, mount `linkedin.scraping`.
- Operation `action`, response envelope `action`.
- Flags: none.



## OpenAPI

````yaml /api-reference/linkedin/openapi.yaml post /api/linkedin-scraping/search-groups
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`, 159
    operations. This is the only OpenAPI document the platform publishes.
    Internal (`/internal`) and health endpoints are deliberately absent: they
    are not part of any contract, they can change without notice, and the
    service source is their only description.


    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
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-groups:
    post:
      tags:
        - linkedin_scraping
      summary: Scrape group search
      description: >-
        One page of a LinkedIn GROUP search, the fifth row kind on this surface.
        `filters` carries keywords and nothing else, exactly like the events
        search, so a pasted /search/results/groups/ `url` is the only way to
        anything the groups screen offers beyond a keyword: send exactly one of
        the two. Rows are groups keyed by group_ln_id, with a /groups/ URL, the
        name, Public or Private, the member counter both as printed and parsed
        (0 is real, null is unread), a best-effort blurb and a logo. WARNING,
        the English dependency is TOTAL, worse than the jobs search: the name is
        read out of English UI copy and a card whose name cannot be read is
        dropped, so a non-English executor returns ZERO rows and still reports
        success. Page on with has_more, never on paging.total.


        Contract:

        - MCP tool `scrape_linkedin_search_groups`, registry package
        `mcp.linkedin/linkedin_scraping`, mount `linkedin.scraping`.

        - Operation `action`, response envelope `action`.

        - Flags: none.
      operationId: scrape_linkedin_search_groups
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScrapeLinkedinSearchGroupsRequest'
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrapeLinkedinSearchGroupsResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    ScrapeLinkedinSearchGroupsRequest:
      type: object
      description: Request body of `scrape_linkedin_search_groups`.
      properties:
        linkedin_account_sid:
          type: string
          nullable: true
          minLength: 18
          maxLength: 18
          pattern: ^ln_ac_
          description: >-
            Executor account (ln_ac_...). OPTIONAL everywhere on this surface.
            Given: the call runs on that account ONLY; a saturated or held
            scraping bucket refuses 429 bucket_saturated (with retry_after).
            Omitted: the service auto-picks one of your connected accounts with
            remaining capacity (SN verbs pick only Sales-Navigator seats; 422
            no_connected_accounts when none is ready, 429 when all are at
            capacity).
        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. Recommended on every search
            run. The KEY ALONE decides: the probe does not compare arguments, so
            reusing one key after changing the arguments hands back the FIRST
            result. On the twelve search verbs that matters twice over, because
            switching a call from filters to url (or back) under one key replays
            instead of running the new search. New search, new key.
        url:
          type: string
          nullable: true
          maxLength: 2048
          pattern: ^https:\/\/www\.linkedin\.com\/search\/results\/groups\/
          description: >-
            EXCLUSIVE with `filters`: send url OR filters, never both (422) and
            never neither (422). A search URL built in the LinkedIn UI, and the
            escape hatch for everything the filter vocabulary cannot express.
            MUST start with https://www.linkedin.com/search/results/groups/ : a
            URL from another LinkedIn search screen is refused here and again by
            the backend (422 invalid_search_url), because running it would
            silently scrape the wrong thing. On the url half OUR number wins:
            the offset or page parameter baked into the pasted URL is
            overwritten, while every other parameter rides through untouched.
        filters:
          type: object
          nullable: true
          properties:
            keywords:
              type: string
              maxLength: 256
              description: >-
                REQUIRED, and the WHOLE vocabulary: the groups search has no
                wire form without a query and no second axis to combine with it.
                Passed to LinkedIn verbatim.
          required:
            - keywords
          additionalProperties: false
          description: >-
            EXCLUSIVE with `url`: send filters OR url, never both (422) and
            never neither (422). LinkedIn groups-search filters. keywords is the
            only member there is, and any other key is REFUSED rather than
            ignored. Anything else the groups screen offers is reachable only by
            building the search in the LinkedIn UI and pasting the URL into the
            url field.
        page:
          type: integer
          minimum: 1
          maximum: 100
          description: >-
            LinkedIn page number, default 1; ONE page per call, so re-call with
            page + 1 while paging.has_more. On the url half OUR number wins: the
            offset or page parameter baked into the pasted URL is overwritten,
            while every other parameter rides through untouched.
    ScrapeLinkedinSearchGroupsResponse:
      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:
                  group_ln_id:
                    type: string
                    description: >-
                      LinkedIn's numeric group id, the only stable identity a
                      group row carries. A card whose id cannot be read is
                      dropped rather than returned half-formed, and a repeat of
                      an id already seen on this page is dropped too.
                  group_url:
                    type: string
                    description: >-
                      https://www.linkedin.com/groups/{group_ln_id}/ , composed
                      from the id, so it is stable and free of tracking
                      parameters.
                  name:
                    type: string
                    description: >-
                      Group name. A card whose name cannot be read is dropped,
                      so this is never null, which is exactly why a non-English
                      executor returns an empty page instead of nameless rows.
                  privacy:
                    type: string
                    nullable: true
                    description: >-
                      "Public" or "Private", LinkedIn's own casing, read from
                      the card's "Public Group" / "Private Group" label.
                      English-only, so it goes null on any other interface
                      language rather than guessing.
                  member_count:
                    type: integer
                    nullable: true
                    description: >-
                      Members, parsed out of members_text. 0 is a REAL value;
                      null means no counter was read at all. Do not conflate the
                      two, and do not test for falsiness.
                  members_text:
                    type: string
                    nullable: true
                    description: >-
                      The counter exactly as LinkedIn printed it ("1,204
                      members").
                  description:
                    type: string
                    nullable: true
                    description: >-
                      Best-effort blurb, ASSEMBLED rather than read: LinkedIn
                      splits the text into several chunks, so the parser
                      collects the human-looking strings in the card and joins
                      them. It can pick up unrelated card copy, so do not hang
                      hard product logic on it.
                  logo_url:
                    type: string
                    nullable: true
                    description: >-
                      Group logo, widest rendition available. Best effort: the
                      card renders several images and the most repeated asset is
                      taken as the logo, so cross-card bleed is possible.
                  position:
                    type: integer
                    nullable: true
                    description: >-
                      The card's slot on THIS page, 0 based and page local, so
                      it is not a rank across pages. Numbering happens before
                      duplicate ids are dropped, which can leave gaps. The
                      parser always fills it, so null means the key was missing
                      from the wire row.
                required:
                  - group_ln_id
                  - group_url
                  - name
                  - privacy
                  - member_count
                  - members_text
                  - description
                  - logo_url
                  - position
              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.
                total carries LinkedIn's own result count when the page printed
                one, best effort and null otherwise, so drive the loop from
                has_more.
            data_request:
              type: object
              properties: {}
              description: >-
                The kind="scrape" DataRequest journal 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
      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.

````