curl --request GET \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/', 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.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"capped": true,
"groups": {
"blocked": 123,
"done": 123,
"in_progress": 123,
"needs_approval": 123,
"paused": 123
},
"total": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Count the contacts a filter matches under each tab
How the contacts matching a search or filter split across the Audience tab’s tabs (In progress, Needs approval, Paused, Done, Blocked), judged as list_sequence_contacts’ ‘group’ lists them under the same filters, so each count is the length of that tab’s filtered list. ‘total’ counts every match; ‘capped’ says more contacts match than one read judges. The page’s tabs read it while its search box or a filter is on; get_audience_eligibility counts the whole roster.
curl --request GET \
--url https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/', 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.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/groups/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"capped": true,
"groups": {
"blocked": 123,
"done": 123,
"in_progress": 123,
"needs_approval": 123,
"paused": 123
},
"total": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Path Parameters
Query Parameters
Where one contact stands in one sequence.
ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the
in-flight guard between claim and outcome. PAUSED is a deliberate
per-contact hold: unclaimable because the tick claims strictly on ACTIVE,
yet still LIVE. It keeps its step and its one-live-sequence slot, and a
compliance stop (reply, unsubscribe) reaches it. Everything else is
settled: COMPLETED walked off the end; STOPPED was halted (reply,
unsubscribe, bounce, manual, company pause); FAILED is terminal;
SUPPRESSED was on the do-not-contact list;
SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the
reason visible in the grid.
A contact the workspace's recontact rule refuses is STOPPED with
StopReason.COOLDOWN. There is deliberately no held state: a cooldown
settles a contact rather than parking them, so nothing here waits on a date
and nothing lets itself out later.
AWAITING_ACTION is a contact parked behind a task that needs a person or a channel, modelled on PAUSED: live, keeps its step and its one-live-sequence slot, unclaimable because the tick claims strictly on ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by hand: only the outreach-task sweep does, once the task it waits on is decided or delivered. Deliberately not "awaiting approval": an AUTO-mode LinkedIn park is waiting for a browser rather than for anyone's approval, and this value is the word the Contacts tab shows for both.
PENDING is a draft's roster: in, standing on a step, and NOT live. Binding
an audience enrols on the spot so the Contacts tab can show who is in, but
a sequence nobody has launched must not hold anybody's one-live-sequence
slot, or a second sequence written for the same people skips them all.
uq_sequence_enrolment_one_live leaves PENDING out, the tick never
claims it, and launch turns each row ACTIVE, settling the ones another
sequence took meanwhile as SKIPPED_DUPLICATE.
pending, active, claimed, paused, awaiting_action, completed, stopped, failed, suppressed, skipped_duplicate reply, unsubscribe, bounce, manual, company_reply, row_left_audience, step_removed, removed, cooldown, rejected, mailbox_removed 255Response
Successful Response
How the contacts a roster filter matches split across the Audience tab's tabs.
More contacts match than one read judges, so each tab's count is at least that many.
How many of the matching contacts sit under each tab. Each one sits under exactly one, and list_sequence_contacts' 'group' with the same filters lists them.
Show child attributes
Show child attributes
Every contact the filters match: the All tab's count.
Was this page helpful?