Get Candidate Data
curl --request POST \
--url https://api.example.com/external/v1/get_candidate_dataimport requests
url = "https://api.example.com/external/v1/get_candidate_data"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/external/v1/get_candidate_data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/external/v1/get_candidate_data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/external/v1/get_candidate_data"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/external/v1/get_candidate_data")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/external/v1/get_candidate_data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyGet Candidate Data
Retrieve candidate details and form element values
POST
/
external
/
v1
/
get_candidate_data
Get Candidate Data
curl --request POST \
--url https://api.example.com/external/v1/get_candidate_dataimport requests
url = "https://api.example.com/external/v1/get_candidate_data"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/external/v1/get_candidate_data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/external/v1/get_candidate_data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/external/v1/get_candidate_data"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/external/v1/get_candidate_data")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/external/v1/get_candidate_data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyGet Candidate Data
Fetch candidate details for a given external identifier and flow ID. Returns stored form element values if requested.Endpoint
POST /external/v1/get_candidate_data
Authentication
[!NOTE] Requires a valid company API key in theAuthorizationheader (format:Api-Key <key>).
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
external_identifier | string | Yes | Unique user identifier |
flow_id | string (UUID) | Yes | The ID of the flow |
form_element_ids | array of strings | No | List of form element IDs to retrieve values for |
Example Request
curl -X POST "https://api.firstwork.com/external/v1/get_candidate_data" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"external_identifier": "EMP-12345",
"flow_id": "550e8400-e29b-41d4-a716-446655440000",
"form_element_ids": ["elem-uuid-1", "elem-uuid-2"]
}'
Responses
200: OK
Successfully retrieved candidate data.400: Bad Request
Invalid request or missing required fields.404: Not Found
Candidate not found.Notes
- For retrieving data across multiple applications, see Candidate Data & Submissions