Get Flow Enrollment Candidate
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"candidateId": "<string>"
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate"
payload = { "candidateId": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({candidateId: '<string>'})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate', 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://gateway.firsttouch.ai/api/public/tools/get_flow_candidate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidateId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"candidate": {
"candidateId": "<string>",
"flowPlanId": "<string>",
"flowPlanName": "<string>",
"status": "Awaiting",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"linkedinUrl": "<string>",
"phone": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"sourceType": "<string>",
"sourceItemId": "<string>",
"created": "2023-11-07T05:31:56Z",
"enrollmentRequestedAt": "2023-11-07T05:31:56Z",
"enrollmentRequestId": "<string>",
"enrollmentId": "<string>",
"canEditCustomVariables": true
},
"customVariables": {},
"customVariablesReady": true
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}Enrollments
Get Flow Enrollment Candidate
Requires the admin team role or global admin access. Check get_current_user.toolAccess before calling.
Gets one enrollment candidate with its saved customVariables dictionary, status, contact identity, source, linked enrollment ids, and canEditCustomVariables.
Usage notes
- Use exact candidateId from list_flow_candidates or candidate_id from get_flow_workspace.awaiting.items; do not supply enrollmentId, queueItemId, or audience contact id.
- Saved keys may be absent from current definitions and are retained.
- Read flow definitions and usage separately through get_flow_workspace.customVariables.
POST
/
api
/
public
/
tools
/
get_flow_candidate
Get Flow Enrollment Candidate
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"candidateId": "<string>"
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate"
payload = { "candidateId": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({candidateId: '<string>'})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate', 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://gateway.firsttouch.ai/api/public/tools/get_flow_candidate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidateId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/get_flow_candidate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"candidate": {
"candidateId": "<string>",
"flowPlanId": "<string>",
"flowPlanName": "<string>",
"status": "Awaiting",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"linkedinUrl": "<string>",
"phone": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"sourceType": "<string>",
"sourceItemId": "<string>",
"created": "2023-11-07T05:31:56Z",
"enrollmentRequestedAt": "2023-11-07T05:31:56Z",
"enrollmentRequestId": "<string>",
"enrollmentId": "<string>",
"canEditCustomVariables": true
},
"customVariables": {},
"customVariablesReady": true
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}