HarvestAPI: Get Group

Retrieve one LinkedIn group by URL or group ID.

Tool ID: harvestapi_get_group

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'harvestapi_get_group',
  {
    "url": "https://example.com/resource",
    "groupId": "group_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute harvestapi_get_group --input '{
  "url": "https://example.com/resource",
  "groupId": "group_123"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "element": {
      "id": "id_123",
      "linkedinUrl": "https://example.com/resource",
      "name": "Example"
    },
    "status": 1,
    "error": "example"
  }
}

Use deepline tools get harvestapi_get_group --json for the latest machine-readable contract.

Input reference

Get the LinkedIn group. Required at least one of the query parameters

Name	Type	Required	Default	Details
`payload.url`	`string`	No	—	URL of the LinkedIn group (optional) Format: `uri`. Minimum length: 1.
`payload.groupId`	`string`	No	—	ID of the LinkedIn group (optional) Minimum length: 1.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.element`	`object`	No	—	—
`result.data.element.id`	`string`	No	—	Unique identifier for the LinkedIn group.
`result.data.element.linkedinUrl`	`string`	No	—	URL of the LinkedIn group. Format: `uri`.
`result.data.element.name`	`string \| null`	No	—	Name of the LinkedIn group.
`result.data.element.memberCount`	`integer \| null`	No	—	Number of members in the group. Format: `int64`.
`result.data.element.logo`	`object \| null`	No	—	Details about the group’s logo.
`result.data.element.logo.url`	`string`	No	—	URL of the group’s logo. Format: `uri`.
`result.data.element.logo.width`	`integer`	No	—	Width of the logo image.
`result.data.element.logo.height`	`integer`	No	—	Height of the logo image.
`result.data.element.logo.expiresAt`	`integer`	No	—	Timestamp when the logo URL expires. Format: `int64`.
`result.data.element.heroImage`	`object \| null`	No	—	Details about the group’s hero image.
`result.data.element.heroImage.url`	`string`	No	—	URL of the group’s hero image. Format: `uri`.
`result.data.element.heroImage.width`	`integer`	No	—	Width of the hero image.
`result.data.element.heroImage.height`	`integer`	No	—	Height of the hero image.
`result.data.element.heroImage.expiresAt`	`integer`	No	—	Timestamp when the hero image URL expires. Format: `int64`.
`result.data.element.description`	`string \| null`	No	—	Description of the LinkedIn group.
`result.data.element.rules`	`string \| null`	No	—	Rules of the LinkedIn group.
`result.data.element.createdAt`	`object \| null`	No	—	Creation timestamp and date of the group.
`result.data.element.createdAt.date`	`string`	No	—	Creation date of the group in string format. Format: `date-time`.
`result.data.element.createdAt.timestamp`	`integer`	No	—	Creation date of the group as a Unix timestamp. Format: `int64`.
`result.data.element.groupPlusStatusActive`	`boolean`	No	—	Indicates if Group Plus status is active.
`result.data.element.postApprovalEnabled`	`boolean`	No	—	Indicates if post approval is enabled for the group.
`result.data.element.invitationLevel`	`string \| null`	No	—	Level of invitation required for the group (e.g., ‘Anyone’, ‘ByInvitation’).
`result.data.element.welcomeNote`	`string \| null`	No	—	Welcome note for new members.
`result.data.element.automatedWelcomeNoteEnabled`	`boolean`	No	—	Indicates if automated welcome note is enabled.
`result.data.element.publicVisibility`	`boolean`	No	—	Indicates if the group is publicly visible.
`result.data.element.admins`	`object`	No	—	Information about the group administrators.
`result.data.element.admins.totalCount`	`integer`	Yes	—	Total count of administrators.
`result.data.element.admins.text`	`string \| null`	No	—	Text representation of administrators (e.g., “John Doe and 2 others”).
`result.data.element.admins.profiles`	`array`	Yes	—	List of admin profiles.
`result.data.element.admins.profiles[].id`	`string`	Yes	—	Unique identifier for the admin profile.
`result.data.element.admins.profiles[].linkedinUrl`	`string`	Yes	—	URL of the admin’s LinkedIn profile. Format: `uri`.
`result.data.element.admins.profiles[].firstName`	`string`	Yes	—	First name of the admin.
`result.data.element.admins.profiles[].lastName`	`string`	Yes	—	Last name of the admin.
`result.data.element.admins.profiles[].headline`	`string \| null`	No	—	Headline of the admin’s LinkedIn profile.
`result.data.element.admins.profiles[].picture`	`string \| object \| null`	No	—	URL or image object for the admin’s profile picture.
`result.data.element.admins.profiles[].picture.url`	`string`	Yes	—	—
`result.data.element.admins.profiles[].picture.width`	`integer`	No	—	—
`result.data.element.admins.profiles[].picture.height`	`integer`	No	—	—
`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.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

HarvestAPI: Get Group

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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