Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Your API key: Authorization: Bearer <your API key>. Authorization: Token <your API key> works too.

Headers

X-Data-Provider
enum<string>
default:harvestapi
required

names the provider: harvestapi. With the host, the only change from the provider's own request.

Available options:
harvestapi

Query Parameters

url
string
required

The profile's LinkedIn URL, e.g. https://www.linkedin.com/in/williamhgates. The only HarvestAPI parameter Datacircle passes on.

Response

HarvestAPI's answer plus datacircle_meta, as HarvestAPI sends it: a 200 whether it found the profile (status: 200, 0.0037 dollar credits) or not (element: null, status: 404, error: Profile not found, 0.0023 dollar credits: HarvestAPI bills the lookup)

HarvestAPI's own answer to GET /linkedin/profile, minus user and requestId (our account with HarvestAPI), plus datacircle_meta.

element
object | null
required

The profile; null when HarvestAPI can't find it (status 404) or refuses the request (status 400).

cost
number
required

What HarvestAPI billed for the call, e.g. 0.0037 for a profile, 0.0023 for a profile it can't find; on a stored answer, what the call that first fetched it was billed. Datacircle charges you the same number of dollar credits (datacircle_meta.dollar_credits_cost, 0 on a stored answer).

entityId
string | null
required

The profile's LinkedIn member id (ACoAA…), as element.id; null when not found.

originalQuery
object
required

The request HarvestAPI got.

payments
string[]
required

What HarvestAPI billed, by name: linkedinProfile for a profile, linkedinProfileShort for a lookup that found nothing.

query
object
required

The request as HarvestAPI understood it: the url it read, with the publicIdentifier and profileId it resolved.

retries
integer
required

How many times HarvestAPI retried LinkedIn for this answer.

status
integer
required

HarvestAPI's own status, inside an HTTP 200: 200 found, 404 not found, 400 a request it refuses.

datacircle_meta
object
required

Datacircle's only addition to the provider's answer

error
string

HarvestAPI's message when element is null, e.g. Profile not found.

free
boolean

true when HarvestAPI didn't bill the call (a request it refuses).