> ## 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 Company

> Retrieve one LinkedIn company by URL, universal name, or search text. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve one LinkedIn company by URL, universal name, or search text.

<Info>
  Tool ID: `harvestapi_get_company`
</Info>

## 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_company',
  {
    "url": "https://example.com/resource",
    "universalName": "Example",
    "search": "software companies hiring engineers"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute harvestapi_get_company --input '{
  "url": "https://example.com/resource",
  "universalName": "Example",
  "search": "software companies hiring engineers"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "element": {
      "id": "id_123",
      "universalName": "Example",
      "linkedinUrl": "https://example.com/resource"
    },
    "status": 1,
    "error": "example"
  }
}
```

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

## Input reference

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

| Name                    | Type     | Required | Default | Details                                                                                           |
| ----------------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `payload.url`           | `string` | No       | —       | URL of the LinkedIn company (optional) Format: `uri`. Minimum length: 1.                          |
| `payload.universalName` | `string` | No       | —       | Universal name of the LinkedIn company profile, can be found in URL (optional) Minimum length: 1. |
| `payload.search`        | `string` | No       | —       | Company name. It will use LinkedIn search and return the most relevant result. Minimum length: 1. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Get the LinkedIn company. Required at least one of the query parameters",
    "properties": {
      "url": {
        "type": "string",
        "description": "URL of the LinkedIn company (optional)",
        "minLength": 1,
        "format": "uri"
      },
      "universalName": {
        "type": "string",
        "description": "Universal name of the LinkedIn company profile, can be found in URL (optional)",
        "minLength": 1
      },
      "search": {
        "type": "string",
        "description": "Company name. It will use LinkedIn search and return the most relevant result.",
        "minLength": 1
      }
    },
    "required": [],
    "allOf": [
      {
        "anyOf": [
          {
            "required": [
              "url"
            ]
          },
          {
            "required": [
              "universalName"
            ]
          },
          {
            "required": [
              "search"
            ]
          }
        ]
      }
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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       | —       | —                          |
| `result.data.element.universalName`                  | `string`          | No       | —       | —                          |
| `result.data.element.linkedinUrl`                    | `string`          | No       | —       | Format: `uri`.             |
| `result.data.element.name`                           | `string`          | No       | —       | —                          |
| `result.data.element.tagline`                        | `string`          | No       | —       | —                          |
| `result.data.element.website`                        | `string`          | No       | —       | Format: `uri`.             |
| `result.data.element.logo`                           | `string`          | No       | —       | Format: `uri`.             |
| `result.data.element.foundedOn`                      | `object`          | No       | —       | —                          |
| `result.data.element.foundedOn.month`                | `integer \| null` | No       | —       | —                          |
| `result.data.element.foundedOn.year`                 | `integer \| null` | No       | —       | —                          |
| `result.data.element.foundedOn.day`                  | `integer \| null` | No       | —       | —                          |
| `result.data.element.employeeCount`                  | `integer`         | No       | —       | —                          |
| `result.data.element.employeeCountRange`             | `object`          | No       | —       | —                          |
| `result.data.element.employeeCountRange.start`       | `integer \| null` | No       | —       | —                          |
| `result.data.element.employeeCountRange.end`         | `integer \| null` | No       | —       | —                          |
| `result.data.element.followerCount`                  | `integer`         | No       | —       | —                          |
| `result.data.element.description`                    | `string`          | No       | —       | —                          |
| `result.data.element.companyType`                    | `string`          | No       | —       | —                          |
| `result.data.element.locations`                      | `array`           | No       | —       | —                          |
| `result.data.element.locations[].country`            | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].city`               | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].geographicArea`     | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].line1`              | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].line2`              | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].postalCode`         | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].headquarter`        | `boolean`         | No       | —       | —                          |
| `result.data.element.locations[].description`        | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].parsed`             | `object`          | No       | —       | —                          |
| `result.data.element.locations[].parsed.text`        | `string`          | No       | —       | —                          |
| `result.data.element.locations[].parsed.countryCode` | `string`          | No       | —       | —                          |
| `result.data.element.locations[].parsed.regionCode`  | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].parsed.country`     | `string`          | No       | —       | —                          |
| `result.data.element.locations[].parsed.countryFull` | `string`          | No       | —       | —                          |
| `result.data.element.locations[].parsed.state`       | `string \| null`  | No       | —       | —                          |
| `result.data.element.locations[].parsed.city`        | `string \| null`  | No       | —       | —                          |
| `result.data.element.specialities`                   | `array`           | No       | —       | —                          |
| `result.data.element.industries`                     | `array`           | No       | —       | —                          |
| `result.data.element.industries[].id`                | `string`          | No       | —       | —                          |
| `result.data.element.industries[].name`              | `string`          | No       | —       | —                          |
| `result.data.element.industries[].urn`               | `string`          | No       | —       | —                          |
| `result.data.element.industries[].title`             | `string`          | No       | —       | —                          |
| `result.data.element.industries[].hierarchy`         | `string`          | No       | —       | —                          |
| `result.data.element.logos`                          | `array`           | No       | —       | —                          |
| `result.data.element.logos[].url`                    | `string`          | No       | —       | Format: `uri`.             |
| `result.data.element.logos[].width`                  | `integer`         | No       | —       | —                          |
| `result.data.element.logos[].height`                 | `integer`         | No       | —       | —                          |
| `result.data.element.backgroundCover`                | `string`          | No       | —       | Format: `uri`.             |
| `result.data.element.backgroundCovers`               | `array`           | No       | —       | —                          |

The table shows the first 50 fields. Expand the raw schema below for every field.

<Info>
  This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get harvestapi_get_company --json`.
</Info>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.03` 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)