API Reference

Enrich profile

get
https://api.pearch.ai/v1/profile

Retrieve enriched user profile based on the provided Linkedin profile ID or email address as a query parameter. Linkedin profile ID is the part that comes after https://www.linkedin.com/in/ in the profile URL.

You can provide either docid (LinkedIn profile ID) or email. If only email is provided, the system will attempt to resolve it to a LinkedIn profile.

Cost: 1 credit + extra credits for each of high_freshness, reveal_emails, reveal_phones and with_profile parameters if enabled. reveal_emails and reveal_phones are 6 credits each when contact data is found. Email lookup adds +1 credit.

Query Params
string

The linkedin profile ID of the profile to retrieve. Linkedin profile ID is the part that comes after https://www.linkedin.com/in/ in the profile URL. Either docid or email must be provided.

string

Email address to look up. If provided without docid, the system will resolve the email to a LinkedIn profile. Cost: +1 credit for email lookup

boolean

Enable real-time profile updates for fresher data. This downloads the most recent copies of profiles directly from source websites in realtime (e.g. Linkedin). Scraped results are cached for up to 24 hours. If you are ok with profiles that may be a few months outdated, turn off high_freshness. Cost: 2 credits

boolean

Include email addresses in the profile if available. Cost: 6 credits, only charged if the profile has at least one email address. Deprecated name: show_emails

boolean

Include phone numbers in the profile if available. Cost: 6 credits, only charged if the profile has at least one phone number. Deprecated name: show_phone_numbers

boolean

Include full profile data in the response. Cost: 1 credit

Responses

400

Invalid parameter values or missing required parameters. At least one of docid or email must be provided. JSON body contains the error message.

401

Invalid API key

404

Profile not found

Updated 11 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago