Skip to main content
The Profile Enrichment API provides a single endpoint to retrieve detailed profile data. Use this endpoint to:
  1. Get Profiles: Retrieve comprehensive information about a user by their username, including personal details, professional experience, education, skills, certifications, and languages.
All endpoints are documented below, generated directly from our OpenAPI specification.

​
Endpoint

GET /api/v1/consumers/{consumer}/profiles/{username} Headers:
HeaderTypeDescription
apikeystringYour API key for access
Path Parameters:
ParameterTypeDescription
consumerstringconsumer value along with apikey
usernamestringusername of the user
Response Headers
HeaderDescription
RateLimit-LimitAllowed limit in the timeframe.
RateLimit-RemainingNumber of available requests remaining.
RateLimit-ResetThe time remaining, in seconds, until the rate limit quota is reset.
X-RateLimit-Limit-SecondThe time limit, in number of seconds.
X-RateLimit-Limit-MinuteThe time limit, in number of minutes.
X-RateLimit-Limit-DayThe time limit, in number of days.
X-RateLimit-Limit-MonthThe time limit, in number of months.
X-RateLimit-Limit-YearThe time limit, in number of years.
X-RateLimit-Remaining-SecondThe number of seconds still left in the time frame.
X-RateLimit-Remaining-MinuteThe number of minutes still left in the time frame.
X-RateLimit-Remaining-DayThe number of days still left in the time frame.
X-RateLimit-Remaining-MonthThe number of months still left in the time frame.
X-RateLimit-Remaining-YearThe number of years still left in the time frame.
Retry-AfterThis header appears on 429 errors, indicating how long the upstream service is expected to be unavailable to the client.
Response: Returns a Profile object with fields including:
  • firstName, lastName
  • headline, summary
  • profilePicture
  • geo (country, city, full)
  • educations (degree, schoolName, start/end dates)
  • position (companyName, title, start/end dates, employmentType)
  • skills (name)
  • certifications (name, authority, company)
  • languages (string or object)
  • publicIdentifier, profileUrn
Response Codes:
CodeDescription
200Profile fetched successfully
401Unauthorized (invalid API key)
404Profile not found