Get Candidate Profile

This endpoint allows you to get a candidate profile using a user's id and their valid JWT

Get Candidate Profile Data

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

uidanyRequired

The UID of the candidate

Responses

200

Success

application/json

uidstringRequired

orgIdstringRequired

orgAliasstringRequired

firstNamestringRequired

lastNamestringRequired

emailstringRequired

phonestringRequired

biostringRequired

dpUrlstringRequired

yoestringRequired

countrystringRequired

citystringRequired

statestringRequired

openToRolesstring[]Required

skillsstring[]Required

websiteLinkstringRequired

linkedInLinkstringRequired

githubLinkstringRequired

otherLinkstringRequired

introLinkstringRequired

pronounsstringRequired

racestringRequired

genderstringRequired

createdAtstringRequired

updatedAtstringRequired

404

Candidate Profile not found

get

/api/v1/candidateProfile/{uid}

HTTPcURLJavaScriptPython

GET /api/v1/candidateProfile/{uid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uid": "text",
  "orgId": "text",
  "orgAlias": "text",
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "phone": "text",
  "bio": "text",
  "dpUrl": "text",
  "yoe": "text",
  "country": "text",
  "city": "text",
  "state": "text",
  "openToRoles": [
    "text"
  ],
  "skills": [
    "text"
  ],
  "websiteLink": "text",
  "linkedInLink": "text",
  "githubLink": "text",
  "otherLink": "text",
  "introLink": "text",
  "workExperiences": [
    {
      "title": "text",
      "company": "text",
      "fromDate": "text",
      "toDate": "text",
      "tillNow": true,
      "experience": "text"
    }
  ],
  "projects": [
    {
      "title": "text",
      "description": "text"
    }
  ],
  "education": [
    {
      "institutionName": "text",
      "courseName": "text",
      "passYear": "text",
      "score": "text"
    }
  ],
  "achievements": [
    {
      "title": "text",
      "description": "text"
    }
  ],
  "pronouns": "text",
  "race": "text",
  "gender": "text",
  "createdAt": "text",
  "updatedAt": "text"
}