Skip to content
Get API key

Get Profile Details by username

GEThttps://api.envoapi.com/v1/profiles/details/by-username

Look up a profile by username to retrieve available identity, headline, location and work history with the EnvoAPI profile details API.

Authorization headerReturns application/json
GET
/v1/profiles/details/by-username

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
username
required
string
>= 1 characters <= 100 characters /^[\p{L}\p{N}][\p{L}\p{M}\p{N}_-]{0,99}$/

The username from the profile URL: the path segment after /in/.

Example

kentcdodds

Responses

Section titled “Responses”

200

Section titled “200”

Profile details with a skills preview. Use Get Profile Skills to see more skills.

Media typeapplication/json
object
data
required
object
publicId
required
string
/^profile_[A-Za-z0-9]{39}$/
username
required
Any of:
string
linkedinUrl
required
Any of:
string
fullName
required
Any of:
string
firstName
required
Any of:
string
lastName
required
Any of:
string
headline
required
Any of:
string
about
required
Any of:
string
profileImages
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
backgroundImages
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
location
required
Any of:
object
displayName
required
Any of:
string
locality
required
Any of:
string
country
required
Any of:
string
countryCode
required
Any of:
string
not matching
displayName
required
null
locality
required
null
country
required
null
countryCode
required
null
industry
required
Any of:
Any of:
object
publicId
required
string
/^industry_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/
name
required
null
primaryLocale
required
Any of:
object
language
required
string
>= 1 characters <= 256 characters /^[a-z]+$/
country
required
Any of:
string
>= 1 characters <= 256 characters /^(?:[A-Z]+|[0-9]+)$/
script
required
Any of:
string
>= 1 characters <= 256 characters /^[A-Z][a-z]+$/
variant
required
Any of:
string
>= 1 characters <= 256 characters /^[a-z0-9]+$/
supportedLocales
required
Any of:
Array<object>
<= 32 items unique items
object
language
required
string
>= 1 characters <= 256 characters /^[a-z]+$/
country
required
Any of:
string
>= 1 characters <= 256 characters /^(?:[A-Z]+|[0-9]+)$/
script
required
Any of:
string
>= 1 characters <= 256 characters /^[A-Z][a-z]+$/
variant
required
Any of:
string
>= 1 characters <= 256 characters /^[a-z0-9]+$/
isPremium
required
Any of:
boolean
isInfluencer
required
Any of:
boolean
isCreator
required
Any of:
boolean
isOpenToWork
required
Any of:
boolean
isHiring
required
Any of:
boolean
isMemorialized
required
Any of:
boolean
counts
required
Any of:
object
followerCount
required
Any of:
integer
<= 9007199254740991
connectionCount
required
Any of:
integer
<= 9007199254740991
not matching
followerCount
required
null
connectionCount
required
null
experience
required
Any of:
Array<object>
object
title
required
Any of:
string
company
required
Any of:
Any of:
object
publicId
required
string
/^company_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/
name
required
null
slug
required
Any of:
string
linkedinUrl
required
Any of:
string
logo
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
industries
required
Any of:
Array
<= 50 items unique items
Any of:
object
publicId
required
string
/^industry_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/
name
required
null
employeeCountRange
required
Any of:
object
start
required
integer
<= 9007199254740991
end
required
Any of:
integer
<= 9007199254740991
employmentType
required
Any of:
object
code
required
Any of:
string
Allowed values: fullTime partTime selfEmployed freelance contract internship apprenticeship seasonal
name
required
Any of:
string
not matching
code
required
null
name
required
null
location
required
Any of:
string
description
required
Any of:
string
dateRange
required
Any of:
Any of:
object
start
required
Any of:
Any of:
object
year
required
integer
>= 1 <= 9999
month
required
Any of:
integer
>= 1 <= 12
day
required
null
end
required
null
isCurrent
required
boolean
media
required
Any of:
Array<object>
object
type
required
Any of:
string
Allowed values: link image
title
required
Any of:
string
description
required
Any of:
string
url
required
Any of:
string
images
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
previewImages
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
providerName
required
Any of:
string
education
required
Any of:
Array<object>
object
school
required
Any of:
Any of:
object
publicId
required
string
/^school_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/
name
required
null
logo
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
degree
required
Any of:
string
fieldOfStudy
required
Any of:
string
grade
required
Any of:
string
activities
required
Any of:
string
description
required
Any of:
string
dateRange
required
Any of:
Any of:
object
start
required
Any of:
Any of:
object
year
required
integer
>= 1 <= 9999
month
required
Any of:
integer
>= 1 <= 12
day
required
null
end
required
null
isCurrent
required
boolean
not matching
school
required
null
degree
required
null
fieldOfStudy
required
null
grade
required
null
activities
required
null
description
required
null
dateRange
required
null
skills
required
Any of:
Array<string>
<= 200 items
certifications
required
Any of:
Array<object>
<= 100 items
One of:
object
name
required
string
issuer
One of:
object
kind
required
string
Allowed value: company
publicId
required
Any of:
string
/^company_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/
name
required
Any of:
string
linkedinUrl
required
Any of:
string
logo
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
associatedSkills
object
names
required
Array<string>
hasMore
required

Whether LinkedIn reports additional associated skills beyond the returned preview.

boolean
media
Array<object>
object
type
required
Any of:
string
Allowed values: link image
title
required
Any of:
string
description
required
Any of:
string
url
required
Any of:
string
images
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
previewImages
required
Any of:
Array<object>
<= 16 items unique items
object
url
required
string format: uri
>= 1 characters <= 11000 characters
width
required
Any of:
integer
>= 1 <= 8192
height
required
Any of:
integer
>= 1 <= 8192
providerName
required
Any of:
string
issuerName
string
issuedOn
Any of:
object
year
required
integer
>= 1 <= 9999
month
required
Any of:
integer
>= 1 <= 12
day
required
null
expiresOn
required
Any of:
object
year
required
integer
>= 1 <= 9999
month
required
Any of:
integer
>= 1 <= 12
day
required
null
doesNotExpire
required
credentialCode
string
credentialUrl
string
description
string
organizations
required
Any of:
Array<object>
<= 100 items
object
organization
required
Any of:
object
publicId
required
string
/^company_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/
name
required
null
role
required
Any of:
string
dateRange
required
Any of:
Any of:
object
start
required
Any of:
Any of:
object
year
required
integer
>= 1 <= 9999
month
required
Any of:
integer
>= 1 <= 12
day
required
null
end
required
null
isCurrent
required
boolean
description
required
Any of:
string
languages
required
Any of:
Array<object>
<= 50 items
object
name
required
string
proficiency
required
Any of:
string
Allowed values: elementary limitedWorking professionalWorking fullProfessional nativeOrBilingual
courses
required
Any of:
Array<object>
<= 100 items
object
name
required
string
associatedWith
required
Any of:
string
volunteerExperience
required
Any of:
Array<object>
<= 100 items
object
role
required
Any of:
string
organization
required
Any of:
Any of:
object
publicId
required
string
/^company_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/
name
required
null
dateRange
required
Any of:
Any of:
object
start
required
Any of:
Any of:
object
year
required
integer
>= 1 <= 9999
month
required
Any of:
integer
>= 1 <= 12
day
required
null
end
required
null
isCurrent
required
boolean
description
required
Any of:
string
not matching
role
required
null
organization
required
null
honors
required
Any of:
Array<object>
<= 100 items
object
title
required
string
issuerName
required
Any of:
string
issuedOn
required
Any of:
Any of:
object
year
required
integer
>= 1 <= 9999
month
required
Any of:
integer
>= 1 <= 12
day
required
null
description
required
Any of:
string
meta
required
object
creditCost
required
integer
<= 9007199254740991
sections

Status of each section: complete, empty, incomplete, or unavailable. Incomplete sections return null, except skills, which may include a preview.

object
counts
required
string
Allowed values: complete empty incomplete unavailable
experience
required
string
Allowed values: complete empty incomplete unavailable
education
required
string
Allowed values: complete empty incomplete unavailable
skills
required
string
Allowed values: complete empty incomplete unavailable
certifications
required
string
Allowed values: complete empty incomplete unavailable
organizations
required
string
Allowed values: complete empty incomplete unavailable
languages
required
string
Allowed values: complete empty incomplete unavailable
courses
required
string
Allowed values: complete empty incomplete unavailable
volunteerExperience
required
string
Allowed values: complete empty incomplete unavailable
honors
required
string
Allowed values: complete empty incomplete unavailable
skills
required
object
hasMore
required
Any of:
boolean

Headers

Section titled “Headers”
Date
string
/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control
string
Allowed value: private, no-store

Required response header.

X-Request-Id
string
>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining
integer
<= 9007199254740991

Required response header.

X-RateLimit-Limit
integer
<= 9007199254740991

Required response header.

X-RateLimit-Remaining
integer
<= 9007199254740991

Required response header.

X-RateLimit-Reset
integer
<= 9007199254740991

Required response header.

Errors

Section titled “Errors”

Every error returns the same body. The status and error.code tell you what went wrong. The Errors guide covers handling and retries.

Body

Section titled “Body”
Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request invalid_api_key insufficient_credits insufficient_scope account_suspended resource_not_found method_not_allowed not_acceptable unsupported_media_type rate_limit_exceeded internal_error response_too_large upstream_error service_unavailable upstream_timeout
message
required
string
>= 1 characters <= 512 characters
retryable
required
boolean
details
required
Array<object>
<= 16 items
object
field
required
string
>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/
code
required
string
Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long
message
required
string
>= 1 characters <= 512 characters
meta
required
object
requestId
required
string
>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Section titled “Headers”
Date
string
/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control
string
Allowed value: private, no-store

Required response header.

X-Request-Id
string
>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

Statuserror.codeMeaning
400invalid_requestA parameter is missing or has a value we cannot use. Read error.details, fix the value and try again.
401invalid_api_keyYour API key is missing, wrong or switched off. Check it in your dashboard.
402insufficient_creditsYour account has no credits left. Top up, then send a new call. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
403insufficient_scope, account_suspendedYour account is suspended or cannot use this endpoint. Resolve the account or its access first.
404resource_not_foundNothing matched what you sent. Check it for typos. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
405method_not_allowedThe route exists, but the request used a method other than GET. Use the method shown at the top of this page. Also sends Allow.
406not_acceptableThe Accept header asks for a format we do not send. Ask for JSON with a supported Accept value.
415unsupported_media_typeThe request declared a media type we do not accept. Remove the body or use the documented media type.
429rate_limit_exceededToo many calls in a short time. Honor Retry-After; use bounded retries with backoff and jitter. Also sends X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After.
500internal_error, response_too_largeSomething failed on our side. Retry only when error.retryable is true. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
502upstream_errorA data source sent back something we could not use. Retry with bounded backoff. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
503service_unavailableLookups are unavailable for a moment. Follow error.retryable, and Retry-After when it is present. Also sends Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Credits-Remaining.
504upstream_timeoutThe lookup ran out of time. Retry with bounded backoff. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.