List Flow Enrollment Candidates
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flowPlanId": "<string>",
"status": "awaiting",
"searchQuery": null,
"limit": 20,
"cursor": null
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates"
payload = {
"flowPlanId": "<string>",
"status": "awaiting",
"searchQuery": None,
"limit": 20,
"cursor": None
}
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({
flowPlanId: '<string>',
status: 'awaiting',
searchQuery: null,
limit: 20,
cursor: null
})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates', 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/list_flow_candidates",
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([
'flowPlanId' => '<string>',
'status' => 'awaiting',
'searchQuery' => null,
'limit' => 20,
'cursor' => null
]),
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/list_flow_candidates"
payload := strings.NewReader("{\n \"flowPlanId\": \"<string>\",\n \"status\": \"awaiting\",\n \"searchQuery\": null,\n \"limit\": 20,\n \"cursor\": null\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/list_flow_candidates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flowPlanId\": \"<string>\",\n \"status\": \"awaiting\",\n \"searchQuery\": null,\n \"limit\": 20,\n \"cursor\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates")
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 \"flowPlanId\": \"<string>\",\n \"status\": \"awaiting\",\n \"searchQuery\": null,\n \"limit\": 20,\n \"cursor\": null\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"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
}
],
"cursor": "<string>",
"totalCount": 123
}{
"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
List Flow Enrollment Candidates
Requires the admin team role or global admin access. Check get_current_user.toolAccess before calling.
Lists compact enrollment candidate records for one flow plan, newest first.
Detailed usage guidance
- Defaults to Awaiting; this includes Awaiting candidates whose enrollment has already been requested, so inspect canEditCustomVariables.
- Set status=null for all statuses.
- Does not return custom input values; use get_flow_candidate for one candidate’s full dictionary.
- Candidate ids can be used in enroll_awaiting_flow_items and cancel_awaiting_flow_items where eligible.
- Keep the same flowPlanId, status, and searchQuery across cursor pages.
POST
/
api
/
public
/
tools
/
list_flow_candidates
List Flow Enrollment Candidates
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flowPlanId": "<string>",
"status": "awaiting",
"searchQuery": null,
"limit": 20,
"cursor": null
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates"
payload = {
"flowPlanId": "<string>",
"status": "awaiting",
"searchQuery": None,
"limit": 20,
"cursor": None
}
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({
flowPlanId: '<string>',
status: 'awaiting',
searchQuery: null,
limit: 20,
cursor: null
})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates', 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/list_flow_candidates",
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([
'flowPlanId' => '<string>',
'status' => 'awaiting',
'searchQuery' => null,
'limit' => 20,
'cursor' => null
]),
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/list_flow_candidates"
payload := strings.NewReader("{\n \"flowPlanId\": \"<string>\",\n \"status\": \"awaiting\",\n \"searchQuery\": null,\n \"limit\": 20,\n \"cursor\": null\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/list_flow_candidates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flowPlanId\": \"<string>\",\n \"status\": \"awaiting\",\n \"searchQuery\": null,\n \"limit\": 20,\n \"cursor\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/list_flow_candidates")
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 \"flowPlanId\": \"<string>\",\n \"status\": \"awaiting\",\n \"searchQuery\": null,\n \"limit\": 20,\n \"cursor\": null\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"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
}
],
"cursor": "<string>",
"totalCount": 123
}{
"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"
}
}Body
application/json