Skip to main content
GET
/
external
/
v1
/
get_candidate_data
Get Candidate
curl --request GET \
  --url https://api.example.com/external/v1/get_candidate_data

Get Candidate Data

Retrieve candidate information including their profile data and associated applications.

Endpoint

GET /external/v1/get_candidate_data

Query Parameters

ParameterTypeRequiredDescription
emailstringYesCandidate’s email address

Example Request

curl -X GET "https://your-instance.firstwork.com/external/v1/get_candidate_data?email=john.doe@example.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "status": "success",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "email": "john.doe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone": "+1234567890",
    "applications": [
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "hiring_flow": "Software Engineer",
        "stage": "Technical Interview",
        "status": "IN_PROGRESS"
      }
    ],
    "created_at": "2025-01-15T10:30:00Z"
  }
}

Get Candidate Data with Submissions

For more detailed candidate data including form submissions:
GET /external/v1/get_candidate_data_and_submissions/
This endpoint returns all form submissions and element-level data for the candidate.