Skip to main content

Retrieve a candidate

GET
/partner/v1.0/standard/candidates/:candidate_id

Retrieves the candidate details and results.


Headers​

  • Accept : application/json
  • Content-Type : application/json
  • Authorization : Bearer {access_token}

Path Parameters​

candidate_id string Required
The unique identifier for the candidate in the Pulsifi system.


Response​

200 OK.

Parameters
candidate_id string
The unique candidate identifier in the Pulsifi system.
ext_reference_id string
The external job application ID from the ATS.
job_id string(uuid)
The status of the job.
is_anonymous_candidate string
Indicates whether the candidate's details should be anonymous.
email boolean
The candidate's email address.
first_name strings
The candidate's first name.
last_name string
The candidate's last name.
status string
The current status of the candidate's assessment.
  • invited
  • expired
  • opened
  • started
  • completed
invitation_link string(URL)
URL to the candidate's assessment invitation.
invitation_expired_at string(UTC Date)
The expiration date and time of the invitation link (UTC format).
created_at string(UTC Date)
The date and time when the invitation was created (UTC format).
report_pdf_link string(URL)
URL to download the candidate's assessment report in PDF format. The link is valid for up to 3 months.
report_profile_link string(URL)
URL to view the candidate's assessment profile.
scores array object
A list of Pulsifi fit scores objects representing different aspects of the candidate's assessment.
Child Parameters
score_format integer
The format of the score (e.g., 100 for percentage).
score_type string
The type of the score (e.g., role_fit, organizational_fit).
score_value integer(max 100)
The value of the score.
additional_scores array object
A list of additional score objects that contribute to actual Pulsifi fit scores.
Child Parameters
score_format integer
The format of the score (e.g., 100 for percentage).
score_type string
The type of the score. (e.g., hard_skill, work_experience,work_interest,work_style, work_value,reasoning_average, reasoning_logical, reasoning_numeric, reasoning_verbal)
score_value integer(max 100)
The value of the score.
GET /standard/candidates/:candidate_id
curl -X GET 'https://staging.api.pulsifi.me/partner/v1.0/standard/candidates/{candidate_id}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
Response
{
  "data": {
    "candidate_id": "<Pulsifi Candidate ID>",
    "ext_reference_id": "<ATS Reference ID>",
    "job_id": "<Pulsifi Job ID>",
    "is_anonymous_candidate": false,
    "email": "johndoe@gmail.com",
    "first_name": "John",
    "last_name": "Doe",
    "status": "completed",
    "invitation_link": "<Invitation Link>",
    "invitation_expired_at": "2024-12-31T23:59:59Z",
    "created_at": "2024-09-02T10:30:00Z",
    "report_pdf_link": "<Report PDF Link>",
    "report_profile_link": "<Report Profile Link>",
    "scores": [
      {
        "score_format": 100,
        "score_type": "role_fit",
        "score_value": 85
      },
      {
        "score_format": 100,
        "score_type": "organizational_fit",
        "score_value": 90
      }
      ],
      "additional_scores": [
      {
        "score_format": 100,
        "score_type": "reasoning_numeric",
        "score_value": 88
      },
      {
        "score_format": 100,
        "score_type": "reasoning_verbal",
        "score_value": 88
      },
      {
        "score_format": 100,
        "score_type": "reasoning_logical",
        "score_value": 88
      }
    ]
  },
  "meta": null
}