One person's full record: verdicts, qualification, enrichment
curl --request GET \
--url http://localhost:8080/sequences/{sequenceId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"avatar_url": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>",
"status": "candidate",
"park_reason": "<string>",
"exit_reason": "<string>",
"fit": 0,
"fit_reason": "<string>",
"batch_key": "<string>",
"source": "<string>",
"next_step_index": 0,
"journey": [
{
"step_index": 0,
"channel": "<string>",
"state": "not_reached",
"at": "2023-11-07T05:31:56Z",
"session_id": "<string>",
"session_ticket_number": 0,
"reason": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"source_detail": "<string>",
"qualification": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"judged_at": "2023-11-07T05:31:56Z",
"input_hash": "<string>",
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"verdicts": [
{
"kind": "must",
"label": "<string>",
"text": "<string>",
"verdict": "pass",
"reasoning": "<string>",
"citations": [
{
"enricher": "<string>",
"kind": "<string>",
"id": "<string>"
}
],
"grade": "high"
}
],
"counts": {
"must_total": 0,
"must_passed": 0,
"must_failed": 0,
"must_unsure": 0,
"nice_total": 0,
"nice_weight_total": 0,
"nice_weight_earned": 0,
"nice_unsure": 0
}
},
"enrichment": {},
"next_eligible_at": "2023-11-07T05:31:56Z",
"next_channel": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}People
One person's full record: verdicts, qualification, enrichment
Read one person in full: identities, status, next step, the complete judgment with verdicts and citations, and the enrichment snapshot the judge saw.
GET
/
sequences
/
{sequenceId}
/
contacts
/
{contactId}
One person's full record: verdicts, qualification, enrichment
curl --request GET \
--url http://localhost:8080/sequences/{sequenceId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/sequences/{sequenceId}/contacts/{contactId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"avatar_url": "<string>",
"phone": "<string>",
"email": "<string>",
"whatsapp_user_id": "<string>",
"status": "candidate",
"park_reason": "<string>",
"exit_reason": "<string>",
"fit": 0,
"fit_reason": "<string>",
"batch_key": "<string>",
"source": "<string>",
"next_step_index": 0,
"journey": [
{
"step_index": 0,
"channel": "<string>",
"state": "not_reached",
"at": "2023-11-07T05:31:56Z",
"session_id": "<string>",
"session_ticket_number": 0,
"reason": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"source_detail": "<string>",
"qualification": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"judged_at": "2023-11-07T05:31:56Z",
"input_hash": "<string>",
"criteria": {
"must": [
{
"label": "<string>",
"text": "<string>"
}
],
"nice": [
{
"label": "<string>",
"text": "<string>",
"grade": "high"
}
]
},
"verdicts": [
{
"kind": "must",
"label": "<string>",
"text": "<string>",
"verdict": "pass",
"reasoning": "<string>",
"citations": [
{
"enricher": "<string>",
"kind": "<string>",
"id": "<string>"
}
],
"grade": "high"
}
],
"counts": {
"must_total": 0,
"must_passed": 0,
"must_failed": 0,
"must_unsure": 0,
"nice_total": 0,
"nice_weight_total": 0,
"nice_weight_earned": 0,
"nice_unsure": 0
}
},
"enrichment": {},
"next_eligible_at": "2023-11-07T05:31:56Z",
"next_channel": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the sequence
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$The person's contact id (from enroll results or the people list)
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
candidate, active, parked, exited, completed Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Was this page helpful?