Skip to main content
POST

Credit Cost

You can select which data to enrich. Credits are only charged for the data types you request (e.g., if you only request phone number, you’ll be charged 10 credits).

Request Body

string
required
Profile identifier. Supports multiple formats:
  • Full URL: https://www.linkedin.com/in/john-doe
  • Short URL: linkedin.com/in/john-doe
  • Public ID: john-doe
  • Encoded ID: prof_PVXj1LZJg54zXKcnKNBusu8LgvJX5SYm5QYj ⭐ (recommended)
  • Twitter/X URL or handle: https://x.com/janedoe, x.com/janedoe, @janedoe
With a Twitter/X identifier, the person is resolved from their X profile and matched to enrich contact data. Email and phone are best-effort for X-sourced profiles — pass a LinkedIn identifier when you have one for the most complete results.
boolean
default:"false"
Enrich the full profile data (experience, education, skills, etc.)
boolean
default:"false"
Enrich professional email address
boolean
default:"false"
Enrich personal email address
boolean
default:"false"
Enrich phone number
boolean
default:"false"
Enrich GitHub profile data (repositories, contributions, etc.). Requires the profile to have a GitHub link.
At least one enrich_* field must be set to true.

Response

object
Full profile data (only present if enrich_profile: true)
string | null
Professional email address (only present if enrich_work_email: true). Example: “[email protected]
string | null
Personal email address (only present if enrich_personal_email: true). Example: “[email protected]
string | null
Phone number (only present if enrich_phone: true). Example: “+1 415 555 0123”
object | null
GitHub profile data (only present if enrich_github: true)
number
Credits charged for this request. Only successful enrichments are charged.