List Campaign Pipeline Automation Leads
curl --request GET \
--url https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads', 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.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"opportunityId": "<string>",
"patientId": "<string>",
"firstName": "<string>",
"status": "OPEN",
"stageEnteredAt": "2023-11-07T05:31:56Z",
"daysInStage": 123,
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"stageColor": "<string>",
"isStale": false,
"automationsPaused": false,
"assignedProviderName": "<string>",
"lastEngagedAt": "2023-11-07T05:31:56Z",
"run": {
"id": "<string>",
"sequenceId": "<string>",
"status": "ACTIVE",
"enrolledAt": "2023-11-07T05:31:56Z",
"sequenceName": "<string>",
"stageId": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"exitReason": "<string>",
"currentStepId": "<string>",
"currentStepEffectType": "SEND_SMS",
"currentStepPosition": 123,
"totalSteps": 0,
"succeeded": 0,
"skipped": 0,
"failed": 0,
"lastStepExecutedAt": "2023-11-07T05:31:56Z",
"nextDueAt": "2023-11-07T05:31:56Z"
}
}
],
"total": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Campaigns
List Campaign Pipeline Automation Leads
Leads of one campaign with the automation step each one is sitting on.
GET
/
opportunity
/
campaign
/
{campaign_id}
/
pipeline-automation
/
leads
List Campaign Pipeline Automation Leads
curl --request GET \
--url https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads', 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.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/opportunity/campaign/{campaign_id}/pipeline-automation/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"opportunityId": "<string>",
"patientId": "<string>",
"firstName": "<string>",
"status": "OPEN",
"stageEnteredAt": "2023-11-07T05:31:56Z",
"daysInStage": 123,
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"stageId": "<string>",
"stageName": "<string>",
"stageColor": "<string>",
"isStale": false,
"automationsPaused": false,
"assignedProviderName": "<string>",
"lastEngagedAt": "2023-11-07T05:31:56Z",
"run": {
"id": "<string>",
"sequenceId": "<string>",
"status": "ACTIVE",
"enrolledAt": "2023-11-07T05:31:56Z",
"sequenceName": "<string>",
"stageId": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"exitReason": "<string>",
"currentStepId": "<string>",
"currentStepEffectType": "SEND_SMS",
"currentStepPosition": 123,
"totalSteps": 0,
"succeeded": 0,
"skipped": 0,
"failed": 0,
"lastStepExecutedAt": "2023-11-07T05:31:56Z",
"nextDueAt": "2023-11-07T05:31:56Z"
}
}
],
"total": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Query Parameters
Lead-list slices, expressed the way an operator asks for them.
Available options:
ALL, ACTIVE, COMPLETED, EXITED, NOT_ENROLLED, PAUSED, NEEDS_ATTENTION Required range:
x >= 1Required range:
1 <= x <= 100
