HarvestAPI: Search Groups

Search LinkedIn groups by keyword.

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.

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

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.

{
  "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.

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).

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation