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

# HarvestAPI: Search Groups

> Search LinkedIn groups by keyword. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Search LinkedIn groups by keyword.

> [!NOTE]
>
> Tool ID: `harvestapi_search_groups`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'harvestapi_search_groups',
  {
    "search": "software companies hiring engineers",
    "page": 1
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute harvestapi_search_groups --input '{
  "search": "software companies hiring engineers",
  "page": 1
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "elements": [
      {
        "id": "id_123"
      }
    ],
    "pagination": {
      "totalPages": 123,
      "totalElements": 123,
      "pageNumber": 123
    },
    "status": 1
  }
}
```

Use `deepline describe harvestapi_search_groups --json` for the latest machine-readable contract.

## Input reference

Retrieve a list of LinkedIn Groups matching the specified search criteria.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.search` | `string` | No | — | Keywords to search for. |
| `payload.page` | `integer` | No | `1` | Page number for pagination. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve a list of LinkedIn Groups matching the specified search criteria.",
    "properties": {
      "search": {
        "type": "string",
        "description": "Keywords to search for."
      },
      "page": {
        "type": "integer",
        "description": "Page number for pagination.",
        "default": 1
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.elements` | `array \| null` | No | — | — |
| `result.data.elements[].id` | `string` | Yes | — | Unique identifier for the LinkedIn group. |
| `result.data.elements[].linkedinUrl` | `string \| null` | No | — | URL of the LinkedIn group. Format: `uri`. |
| `result.data.elements[].name` | `string \| null` | No | — | Name of the LinkedIn group. |
| `result.data.elements[].members` | `string \| null` | No | — | Text representation of the member count (e.g., '10,000+ members'). |
| `result.data.elements[].summary` | `string \| null` | No | — | Short summary or description of the group. |
| `result.data.elements[].picture` | `string \| null` | No | — | URL of the group's profile picture. Format: `uri`. |
| `result.data.elements[].primaryActions` | `array \| null` | No | — | List of primary actions related to the group. |
| `result.data.elements[].primaryActions[].label` | `string \| null` | No | — | Label for the action (e.g., 'Join', 'View'). |
| `result.data.elements[].primaryActions[].value` | `string \| null` | No | — | Value associated with the action (e.g., a URL or action ID). |
| `result.data.pagination` | `object` | No | — | — |
| `result.data.pagination.totalPages` | `integer` | No | — | Format: `int32`. |
| `result.data.pagination.totalElements` | `integer` | No | — | Format: `int32`. |
| `result.data.pagination.pageNumber` | `integer` | No | — | Format: `int32`. |
| `result.data.pagination.previousElements` | `integer` | No | — | Format: `int32`. |
| `result.data.pagination.pageSize` | `integer` | No | — | Format: `int32`. |
| `result.data.pagination.paginationToken` | `string` | No | — | Format: `nullable`. |
| `result.data.status` | `string \| integer` | No | — | — |
| `result.data.error` | `string \| null` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "elements": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the LinkedIn group."
                },
                "linkedinUrl": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "URL of the LinkedIn group.",
                  "format": "uri"
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Name of the LinkedIn group."
                },
                "members": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Text representation of the member count (e.g., '10,000+ members')."
                },
                "summary": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Short summary or description of the group."
                },
                "picture": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "URL of the group's profile picture.",
                  "format": "uri"
                },
                "primaryActions": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "description": "List of primary actions related to the group.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "label": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Label for the action (e.g., 'Join', 'View')."
                      },
                      "value": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Value associated with the action (e.g., a URL or action ID)."
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "id"
              ],
              "additionalProperties": false
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "totalPages": {
                "type": "integer",
                "format": "int32"
              },
              "totalElements": {
                "type": "integer",
                "format": "int32"
              },
              "pageNumber": {
                "type": "integer",
                "format": "int32"
              },
              "previousElements": {
                "type": "integer",
                "format": "int32"
              },
              "pageSize": {
                "type": "integer",
                "format": "int32"
              },
              "paginationToken": {
                "type": "string",
                "format": "nullable"
              }
            },
            "additionalProperties": false
          },
          "status": {
            "type": [
              "string",
              "integer"
            ]
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [HarvestAPI provider guide](https://deepline.com/docs/providers/harvestapi/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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