cURL
curl --request POST \
--url https://api.unifygtm.com/sequences/v1/enrollments/query-jobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"filter": {
"updated_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"mailbox": {
"id": "<string>",
"email_address": "<string>"
},
"started_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"ended_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"id": {
"in": [
"<string>"
],
"not_in": [
"<string>"
]
},
"is_blocked": true,
"is_bounced": true,
"is_canceled": true,
"is_opted_out": true,
"is_paused": true,
"is_replied": true,
"status": {
"in": [],
"not_in": []
},
"enrolled_by_play": {
"in": [
"<string>"
],
"not_in": [
"<string>"
]
}
}
}
'import requests
url = "https://api.unifygtm.com/sequences/v1/enrollments/query-jobs"
payload = { "filter": {
"updated_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"mailbox": {
"id": "<string>",
"email_address": "<string>"
},
"started_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"ended_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"id": {
"in": ["<string>"],
"not_in": ["<string>"]
},
"is_blocked": True,
"is_bounced": True,
"is_canceled": True,
"is_opted_out": True,
"is_paused": True,
"is_replied": True,
"status": {
"in": [],
"not_in": []
},
"enrolled_by_play": {
"in": ["<string>"],
"not_in": ["<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({
filter: {
updated_at: {gt: '<string>', gte: '<string>', lt: '<string>', lte: '<string>'},
mailbox: {id: '<string>', email_address: '<string>'},
started_at: {gt: '<string>', gte: '<string>', lt: '<string>', lte: '<string>'},
ended_at: {gt: '<string>', gte: '<string>', lt: '<string>', lte: '<string>'},
id: {in: ['<string>'], not_in: ['<string>']},
is_blocked: true,
is_bounced: true,
is_canceled: true,
is_opted_out: true,
is_paused: true,
is_replied: true,
status: {in: [], not_in: []},
enrolled_by_play: {in: ['<string>'], not_in: ['<string>']}
}
})
};
fetch('https://api.unifygtm.com/sequences/v1/enrollments/query-jobs', 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.unifygtm.com/sequences/v1/enrollments/query-jobs",
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([
'filter' => [
'updated_at' => [
'gt' => '<string>',
'gte' => '<string>',
'lt' => '<string>',
'lte' => '<string>'
],
'mailbox' => [
'id' => '<string>',
'email_address' => '<string>'
],
'started_at' => [
'gt' => '<string>',
'gte' => '<string>',
'lt' => '<string>',
'lte' => '<string>'
],
'ended_at' => [
'gt' => '<string>',
'gte' => '<string>',
'lt' => '<string>',
'lte' => '<string>'
],
'id' => [
'in' => [
'<string>'
],
'not_in' => [
'<string>'
]
],
'is_blocked' => true,
'is_bounced' => true,
'is_canceled' => true,
'is_opted_out' => true,
'is_paused' => true,
'is_replied' => true,
'status' => [
'in' => [
],
'not_in' => [
]
],
'enrolled_by_play' => [
'in' => [
'<string>'
],
'not_in' => [
'<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://api.unifygtm.com/sequences/v1/enrollments/query-jobs"
payload := strings.NewReader("{\n \"filter\": {\n \"updated_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"mailbox\": {\n \"id\": \"<string>\",\n \"email_address\": \"<string>\"\n },\n \"started_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"ended_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"id\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n },\n \"is_blocked\": true,\n \"is_bounced\": true,\n \"is_canceled\": true,\n \"is_opted_out\": true,\n \"is_paused\": true,\n \"is_replied\": true,\n \"status\": {\n \"in\": [],\n \"not_in\": []\n },\n \"enrolled_by_play\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n }\n }\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://api.unifygtm.com/sequences/v1/enrollments/query-jobs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"updated_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"mailbox\": {\n \"id\": \"<string>\",\n \"email_address\": \"<string>\"\n },\n \"started_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"ended_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"id\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n },\n \"is_blocked\": true,\n \"is_bounced\": true,\n \"is_canceled\": true,\n \"is_opted_out\": true,\n \"is_paused\": true,\n \"is_replied\": true,\n \"status\": {\n \"in\": [],\n \"not_in\": []\n },\n \"enrolled_by_play\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unifygtm.com/sequences/v1/enrollments/query-jobs")
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 \"filter\": {\n \"updated_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"mailbox\": {\n \"id\": \"<string>\",\n \"email_address\": \"<string>\"\n },\n \"started_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"ended_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"id\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n },\n \"is_blocked\": true,\n \"is_bounced\": true,\n \"is_canceled\": true,\n \"is_opted_out\": true,\n \"is_paused\": true,\n \"is_replied\": true,\n \"status\": {\n \"in\": [],\n \"not_in\": []\n },\n \"enrolled_by_play\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "IN_PROGRESS",
"expires_at": "<string>"
}{
"status": "bad_request",
"errors": [
{
"code": "<string>",
"path": [
"<string>"
],
"object_api_name": "<string>",
"attribute_api_name": "<string>"
}
],
"message": "<string>"
}{
"status": "unauthorized",
"message": "<string>"
}{
"status": "rate_limited",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Query enrollments
Create job
Create a job to query sequence enrollments.
POST
/
sequences
/
v1
/
enrollments
/
query-jobs
cURL
curl --request POST \
--url https://api.unifygtm.com/sequences/v1/enrollments/query-jobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"filter": {
"updated_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"mailbox": {
"id": "<string>",
"email_address": "<string>"
},
"started_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"ended_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"id": {
"in": [
"<string>"
],
"not_in": [
"<string>"
]
},
"is_blocked": true,
"is_bounced": true,
"is_canceled": true,
"is_opted_out": true,
"is_paused": true,
"is_replied": true,
"status": {
"in": [],
"not_in": []
},
"enrolled_by_play": {
"in": [
"<string>"
],
"not_in": [
"<string>"
]
}
}
}
'import requests
url = "https://api.unifygtm.com/sequences/v1/enrollments/query-jobs"
payload = { "filter": {
"updated_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"mailbox": {
"id": "<string>",
"email_address": "<string>"
},
"started_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"ended_at": {
"gt": "<string>",
"gte": "<string>",
"lt": "<string>",
"lte": "<string>"
},
"id": {
"in": ["<string>"],
"not_in": ["<string>"]
},
"is_blocked": True,
"is_bounced": True,
"is_canceled": True,
"is_opted_out": True,
"is_paused": True,
"is_replied": True,
"status": {
"in": [],
"not_in": []
},
"enrolled_by_play": {
"in": ["<string>"],
"not_in": ["<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({
filter: {
updated_at: {gt: '<string>', gte: '<string>', lt: '<string>', lte: '<string>'},
mailbox: {id: '<string>', email_address: '<string>'},
started_at: {gt: '<string>', gte: '<string>', lt: '<string>', lte: '<string>'},
ended_at: {gt: '<string>', gte: '<string>', lt: '<string>', lte: '<string>'},
id: {in: ['<string>'], not_in: ['<string>']},
is_blocked: true,
is_bounced: true,
is_canceled: true,
is_opted_out: true,
is_paused: true,
is_replied: true,
status: {in: [], not_in: []},
enrolled_by_play: {in: ['<string>'], not_in: ['<string>']}
}
})
};
fetch('https://api.unifygtm.com/sequences/v1/enrollments/query-jobs', 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.unifygtm.com/sequences/v1/enrollments/query-jobs",
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([
'filter' => [
'updated_at' => [
'gt' => '<string>',
'gte' => '<string>',
'lt' => '<string>',
'lte' => '<string>'
],
'mailbox' => [
'id' => '<string>',
'email_address' => '<string>'
],
'started_at' => [
'gt' => '<string>',
'gte' => '<string>',
'lt' => '<string>',
'lte' => '<string>'
],
'ended_at' => [
'gt' => '<string>',
'gte' => '<string>',
'lt' => '<string>',
'lte' => '<string>'
],
'id' => [
'in' => [
'<string>'
],
'not_in' => [
'<string>'
]
],
'is_blocked' => true,
'is_bounced' => true,
'is_canceled' => true,
'is_opted_out' => true,
'is_paused' => true,
'is_replied' => true,
'status' => [
'in' => [
],
'not_in' => [
]
],
'enrolled_by_play' => [
'in' => [
'<string>'
],
'not_in' => [
'<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://api.unifygtm.com/sequences/v1/enrollments/query-jobs"
payload := strings.NewReader("{\n \"filter\": {\n \"updated_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"mailbox\": {\n \"id\": \"<string>\",\n \"email_address\": \"<string>\"\n },\n \"started_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"ended_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"id\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n },\n \"is_blocked\": true,\n \"is_bounced\": true,\n \"is_canceled\": true,\n \"is_opted_out\": true,\n \"is_paused\": true,\n \"is_replied\": true,\n \"status\": {\n \"in\": [],\n \"not_in\": []\n },\n \"enrolled_by_play\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n }\n }\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://api.unifygtm.com/sequences/v1/enrollments/query-jobs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"updated_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"mailbox\": {\n \"id\": \"<string>\",\n \"email_address\": \"<string>\"\n },\n \"started_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"ended_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"id\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n },\n \"is_blocked\": true,\n \"is_bounced\": true,\n \"is_canceled\": true,\n \"is_opted_out\": true,\n \"is_paused\": true,\n \"is_replied\": true,\n \"status\": {\n \"in\": [],\n \"not_in\": []\n },\n \"enrolled_by_play\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unifygtm.com/sequences/v1/enrollments/query-jobs")
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 \"filter\": {\n \"updated_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"mailbox\": {\n \"id\": \"<string>\",\n \"email_address\": \"<string>\"\n },\n \"started_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"ended_at\": {\n \"gt\": \"<string>\",\n \"gte\": \"<string>\",\n \"lt\": \"<string>\",\n \"lte\": \"<string>\"\n },\n \"id\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n },\n \"is_blocked\": true,\n \"is_bounced\": true,\n \"is_canceled\": true,\n \"is_opted_out\": true,\n \"is_paused\": true,\n \"is_replied\": true,\n \"status\": {\n \"in\": [],\n \"not_in\": []\n },\n \"enrolled_by_play\": {\n \"in\": [\n \"<string>\"\n ],\n \"not_in\": [\n \"<string>\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "IN_PROGRESS",
"expires_at": "<string>"
}{
"status": "bad_request",
"errors": [
{
"code": "<string>",
"path": [
"<string>"
],
"object_api_name": "<string>",
"attribute_api_name": "<string>"
}
],
"message": "<string>"
}{
"status": "unauthorized",
"message": "<string>"
}{
"status": "rate_limited",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Overview
Create a query job to query and export enrollments. Use the request body to optionally filter or sort the results. See Using query jobs for an overview of using jobs to query data.Authorizations
Body
application/json
Request body for creating a sequence enrollment query jobs query job.
Filters that select the enrollments to export. Omit to export all enrollments.
Show child attributes
Show child attributes
⌘I