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

> Scrape one LinkedIn profile by URL: current role, work experience, education, skills, and location, optionally including email discovery.

Scrape one LinkedIn profile by URL: current role, work experience, education, skills, and location, optionally including email discovery.

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

## 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_get_profile',
  {
    "url": "https://example.com/resource",
    "publicIdentifier": "example_123",
    "profileId": "profile_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute harvestapi_get_profile --input '{
  "url": "https://example.com/resource",
  "publicIdentifier": "example_123",
  "profileId": "profile_123"
}' --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": {
    "element": {
      "id": "id_123",
      "publicIdentifier": "example_123",
      "linkedinUrl": "https://example.com/resource"
    },
    "status": 1,
    "error": "example"
  }
}
```

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

## Input reference

Get one LinkedIn profile. provide at least one of url, publicIdentifier, or profileId.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.url` | `string` | No | — | URL of the LinkedIn profile (optional) Format: `uri`. Minimum length: 1. |
| `payload.publicIdentifier` | `string` | No | — | Public identifier of the LinkedIn profile (optional) Minimum length: 1. |
| `payload.profileId` | `string` | No | — | ID of the LinkedIn profile (optional) Minimum length: 1. |
| `payload.main` | `string` | No | — | Omit (recommended) for the more complete profile. "true" returns an abbreviated, cheaper profile. website fields are not guaranteed in either mode. |
| `payload.findEmail` | `string` | No | — | "true" enables email discovery at a higher request price. omit or set "false" for profile only. SMTP verification is enabled unless skipSmtp="true". Catch-all emails are marked risky, not verified deliverable. |
| `payload.skipSmtp` | `string` | No | — | Only with findEmail="true": set "true" to skip SMTP verification at a lower email-discovery request price. Generated email candidates receive minimal checks such as MX lookup, not a deliverability guarantee. Omit or set "false" to retain SMTP verification. |
| `payload.includeAboutProfile` | `string` | No | — | Include this parameter to scrape the "About this profile" popup from LinkedIn profiles. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get one LinkedIn profile; provide at least one of url, publicIdentifier, or profileId.",
    "properties": {
      "url": {
        "type": "string",
        "description": "URL of the LinkedIn profile (optional)",
        "minLength": 1,
        "format": "uri",
        "aliases": [
          "profile"
        ]
      },
      "publicIdentifier": {
        "type": "string",
        "description": "Public identifier of the LinkedIn profile (optional)",
        "minLength": 1,
        "aliases": [
          "profile"
        ]
      },
      "profileId": {
        "type": "string",
        "description": "ID of the LinkedIn profile (optional)",
        "minLength": 1
      },
      "main": {
        "type": "string",
        "description": "Omit (recommended) for the more complete profile. \"true\" returns an abbreviated, cheaper profile; website fields are not guaranteed in either mode."
      },
      "findEmail": {
        "type": "string",
        "description": "\"true\" enables email discovery at a higher request price; omit or set \"false\" for profile only. SMTP verification is enabled unless skipSmtp=\"true\". Catch-all emails are marked risky, not verified deliverable."
      },
      "skipSmtp": {
        "type": "string",
        "description": "Only with findEmail=\"true\": set \"true\" to skip SMTP verification at a lower email-discovery request price. Generated email candidates receive minimal checks such as MX lookup, not a deliverability guarantee. Omit or set \"false\" to retain SMTP verification."
      },
      "includeAboutProfile": {
        "type": "string",
        "description": "Include this parameter to scrape the \"About this profile\" popup from LinkedIn profiles."
      }
    },
    "required": [],
    "allOf": [
      {
        "anyOf": [
          {
            "required": [
              "url"
            ]
          },
          {
            "required": [
              "publicIdentifier"
            ]
          },
          {
            "required": [
              "profileId"
            ]
          }
        ]
      }
    ],
    "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.publicIdentifier` | `string` | No | — | — |
| `result.data.element.linkedinUrl` | `string` | No | — | Format: `uri`. |
| `result.data.element.firstName` | `string` | No | — | — |
| `result.data.element.lastName` | `string` | No | — | — |
| `result.data.element.emails` | `array` | No | — | — |
| `result.data.element.emails[].email` | `string` | No | — | Format: `email`. |
| `result.data.element.emails[].deliverable` | `boolean` | No | — | — |
| `result.data.element.emails[].catchAllDomain` | `boolean` | No | — | — |
| `result.data.element.emails[].validEmailServer` | `boolean` | No | — | — |
| `result.data.element.emails[].free` | `boolean` | No | — | — |
| `result.data.element.emails[].status` | `string` | No | — | — |
| `result.data.element.emails[].qualityScore` | `integer` | No | — | — |
| `result.data.element.websites` | `array` | No | — | — |
| `result.data.element.companyWebsites` | `array` | No | — | — |
| `result.data.element.headline` | `string` | No | — | — |
| `result.data.element.openToWork` | `boolean` | No | — | — |
| `result.data.element.hiring` | `boolean` | No | — | — |
| `result.data.element.premium` | `boolean` | No | — | — |
| `result.data.element.influencer` | `boolean` | No | — | — |
| `result.data.element.memorialized` | `boolean` | No | — | — |
| `result.data.element.creator` | `boolean` | No | — | — |
| `result.data.element.location` | `object` | No | — | — |
| `result.data.element.location.linkedinText` | `string` | No | — | — |
| `result.data.element.location.countryCode` | `string` | No | — | — |
| `result.data.element.location.parsed` | `object` | No | — | — |
| `result.data.element.location.parsed.text` | `string` | No | — | — |
| `result.data.element.location.parsed.countryCode` | `string` | No | — | — |
| `result.data.element.location.parsed.regionCode` | `string \| null` | No | — | — |
| `result.data.element.location.parsed.country` | `string` | No | — | — |
| `result.data.element.location.parsed.countryFull` | `string` | No | — | — |
| `result.data.element.location.parsed.state` | `string` | No | — | — |
| `result.data.element.location.parsed.city` | `string` | No | — | — |
| `result.data.element.objectUrn` | `string` | No | — | — |
| `result.data.element.registeredAt` | `string` | No | — | Format: `date-time`. |
| `result.data.element.topSkills` | `array` | No | — | — |
| `result.data.element.connectionsCount` | `integer` | No | — | — |
| `result.data.element.followerCount` | `integer` | No | — | — |
| `result.data.element.verified` | `boolean` | No | — | — |
| `result.data.element.about` | `string` | No | — | — |
| `result.data.element.currentPosition` | `array` | No | — | — |
| `result.data.element.currentPosition[].position` | `string` | No | — | — |
| `result.data.element.currentPosition[].location` | `string \| null` | No | — | — |
| `result.data.element.currentPosition[].employmentType` | `string \| null` | No | — | — |
| `result.data.element.currentPosition[].workplaceType` | `string \| null` | No | — | — |
| `result.data.element.currentPosition[].companyName` | `string` | No | — | — |
| `result.data.element.currentPosition[].companyLinkedinUrl` | `string` | No | — | Format: `uri`. |
| `result.data.element.currentPosition[].companyId` | `string` | No | — | — |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe harvestapi_get_profile --json`.

## Deepline cost

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