Individual Lookup

Check whether one person has the Open to Work badge set on their LinkedIn profile. Synchronous, returns the flag directly.

POST /open_to_work

Costs 0.3 credits per row. Returns the flag directly in the response, no list and no polling.

Pass a LinkedIn profile URL. The response contains a boolean in data.open_to_work.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
api_key	string	Your API Key.
person_linkedin_url	string	LinkedIn profile URL of the person to look up.

Example

Input

{
  "api_key": "your_api_key",
  "person_linkedin_url": "https://www.linkedin.com/in/jane-doe-example/"
}

Output

{
  "status": "success",
  "data": {
    "person_linkedin_url": "https://www.linkedin.com/in/jane-doe-example/",
    "open_to_work": false
  },
  "credits_used": 0.3,
  "credits_remaining": 4823,
  "success": true
}

Not found

{
  "status": "not_found",
  "data": {
    "person_linkedin_url": "https://www.linkedin.com/in/jane-doe-example/",
    "open_to_work": null
  },
  "credits_used": 0,
  "credits_remaining": 4823,
  "success": true
}

Error

{
  "status": "error",
  "error": {
    "code": "validation_error",
    "message": "person_linkedin_url: Field required"
  },
  "success": false
}

Response

Field	Type	Description
person_linkedin_url	string	The profile that was looked up.
open_to_work	boolean	true when the badge is set, false when it is not.

The record is under data. See Response Format for the fields every endpoint returns.

To check every contact in a list in one call instead, use List Lookup.