Skip to main content
GET
Get Profile Details

Authorizations

x-api-key
string
header
required

Include your API key in the x-api-key header to authenticate requests. Each organisation is provided with a unique API key. If your key is lost or compromised, contact support to request a new one.

Path Parameters

publicIdentifier
string
required

The unique identifier of the profile.

Response

Profile details retrieved successfully.

id
string

The unique identifier of the profile.

Example:

"abc123"

email
string

The user's email address.

Example:

"user@example.com"

publicIdentifier
string

A unique public identifier for the user.

Example:

"john-doe-1234"

firstName
string

The user's first name.

Example:

"John"

lastName
string

The user's last name.

Example:

"Doe"

fullName
string

The user's full name.

Example:

"John Doe"

certifications
object[]

List of certifications obtained by the user.

educations
object[]

List of educational backgrounds.

workHistory
object[]

Work experience history.