HarvestAPI: Get Profile

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

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.

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

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.

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

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.

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.

​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