> ## 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: Get Group
> Retrieve one LinkedIn group by URL or group ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
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.
```ts theme={null}
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
```bash theme={null}
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.
```json theme={null}
{
"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. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get the LinkedIn group. Required at least one of the query parameters",
"properties": {
"url": {
"type": "string",
"description": "URL of the LinkedIn group (optional)",
"minLength": 1,
"format": "uri"
},
"groupId": {
"type": "string",
"description": "ID of the LinkedIn group (optional)",
"minLength": 1
}
},
"required": [],
"allOf": [
{
"anyOf": [
{
"required": [
"url"
]
},
{
"required": [
"groupId"
]
}
]
}
],
"additionalProperties": false
}
```
## 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). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"element": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the LinkedIn group."
},
"linkedinUrl": {
"type": "string",
"description": "URL of the LinkedIn group.",
"format": "uri"
},
"name": {
"type": [
"string",
"null"
],
"description": "Name of the LinkedIn group."
},
"memberCount": {
"type": [
"integer",
"null"
],
"description": "Number of members in the group.",
"format": "int64"
},
"logo": {
"type": [
"object",
"null"
],
"description": "Details about the group's logo.",
"properties": {
"url": {
"type": "string",
"description": "URL of the group's logo.",
"format": "uri"
},
"width": {
"type": "integer",
"description": "Width of the logo image."
},
"height": {
"type": "integer",
"description": "Height of the logo image."
},
"expiresAt": {
"type": "integer",
"description": "Timestamp when the logo URL expires.",
"format": "int64"
}
},
"additionalProperties": false
},
"heroImage": {
"type": [
"object",
"null"
],
"description": "Details about the group's hero image.",
"properties": {
"url": {
"type": "string",
"description": "URL of the group's hero image.",
"format": "uri"
},
"width": {
"type": "integer",
"description": "Width of the hero image."
},
"height": {
"type": "integer",
"description": "Height of the hero image."
},
"expiresAt": {
"type": "integer",
"description": "Timestamp when the hero image URL expires.",
"format": "int64"
}
},
"additionalProperties": false
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the LinkedIn group."
},
"rules": {
"type": [
"string",
"null"
],
"description": "Rules of the LinkedIn group."
},
"createdAt": {
"type": [
"object",
"null"
],
"description": "Creation timestamp and date of the group.",
"properties": {
"date": {
"type": "string",
"description": "Creation date of the group in string format.",
"format": "date-time"
},
"timestamp": {
"type": "integer",
"description": "Creation date of the group as a Unix timestamp.",
"format": "int64"
}
},
"additionalProperties": false
},
"groupPlusStatusActive": {
"type": "boolean",
"description": "Indicates if Group Plus status is active."
},
"postApprovalEnabled": {
"type": "boolean",
"description": "Indicates if post approval is enabled for the group."
},
"invitationLevel": {
"type": [
"string",
"null"
],
"description": "Level of invitation required for the group (e.g., 'Anyone', 'ByInvitation')."
},
"welcomeNote": {
"type": [
"string",
"null"
],
"description": "Welcome note for new members."
},
"automatedWelcomeNoteEnabled": {
"type": "boolean",
"description": "Indicates if automated welcome note is enabled."
},
"publicVisibility": {
"type": "boolean",
"description": "Indicates if the group is publicly visible."
},
"admins": {
"type": "object",
"description": "Information about the group administrators.",
"properties": {
"totalCount": {
"type": "integer",
"description": "Total count of administrators."
},
"text": {
"type": [
"string",
"null"
],
"description": "Text representation of administrators (e.g., \"John Doe and 2 others\")."
},
"profiles": {
"type": "array",
"description": "List of admin profiles.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the admin profile."
},
"linkedinUrl": {
"type": "string",
"description": "URL of the admin's LinkedIn profile.",
"format": "uri"
},
"firstName": {
"type": "string",
"description": "First name of the admin."
},
"lastName": {
"type": "string",
"description": "Last name of the admin."
},
"headline": {
"type": [
"string",
"null"
],
"description": "Headline of the admin's LinkedIn profile."
},
"picture": {
"description": "URL or image object for the admin's profile picture.",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
}
},
"required": [
"url"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"linkedinUrl",
"firstName",
"lastName"
],
"additionalProperties": false
}
}
},
"required": [
"totalCount",
"profiles"
],
"additionalProperties": false
}
},
"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
}
```
## Deepline cost
* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.02` per pricing unit.
## Related documentation
* [HarvestAPI provider guide](/docs/providers/harvestapi/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)