cURL
curl --request GET \
--url https://api.unifygtm.com/sequences/v1/enrollments/{id}/steps \
--header 'x-api-key: <api-key>'import requests
url = "https://api.unifygtm.com/sequences/v1/enrollments/{id}/steps"
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.unifygtm.com/sequences/v1/enrollments/{id}/steps', 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/{id}/steps",
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.unifygtm.com/sequences/v1/enrollments/{id}/steps"
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.unifygtm.com/sequences/v1/enrollments/{id}/steps")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unifygtm.com/sequences/v1/enrollments/{id}/steps")
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{
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "AUTOMATIC_EMAIL",
"status": "NOT_STARTED",
"step_number": 2,
"is_blocked": true,
"is_bounced": true,
"is_canceled": true,
"is_opted_out": true,
"is_paused": true,
"is_replied": true,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"email": {
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject": "<string>",
"fallback_subject": "<string>",
"body": "<string>",
"is_ready": true,
"is_edited": true,
"is_root_message": true,
"is_blocked": true,
"scheduled_send_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"status": "bad_request",
"errors": [
{
"code": "<string>",
"path": [
"<string>"
],
"object_api_name": "<string>",
"attribute_api_name": "<string>"
}
],
"message": "<string>"
}{
"status": "unauthorized",
"message": "<string>"
}{
"status": "not_found",
"message": "<string>"
}{
"status": "rate_limited",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Enrollments
List enrollment steps
List one person’s steps in a sequence, including email copy.
GET
/
sequences
/
v1
/
enrollments
/
{id}
/
steps
cURL
curl --request GET \
--url https://api.unifygtm.com/sequences/v1/enrollments/{id}/steps \
--header 'x-api-key: <api-key>'import requests
url = "https://api.unifygtm.com/sequences/v1/enrollments/{id}/steps"
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.unifygtm.com/sequences/v1/enrollments/{id}/steps', 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/{id}/steps",
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.unifygtm.com/sequences/v1/enrollments/{id}/steps"
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.unifygtm.com/sequences/v1/enrollments/{id}/steps")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unifygtm.com/sequences/v1/enrollments/{id}/steps")
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{
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "AUTOMATIC_EMAIL",
"status": "NOT_STARTED",
"step_number": 2,
"is_blocked": true,
"is_bounced": true,
"is_canceled": true,
"is_opted_out": true,
"is_paused": true,
"is_replied": true,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"email": {
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject": "<string>",
"fallback_subject": "<string>",
"body": "<string>",
"is_ready": true,
"is_edited": true,
"is_root_message": true,
"is_blocked": true,
"scheduled_send_at": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"status": "bad_request",
"errors": [
{
"code": "<string>",
"path": [
"<string>"
],
"object_api_name": "<string>",
"attribute_api_name": "<string>"
}
],
"message": "<string>"
}{
"status": "unauthorized",
"message": "<string>"
}{
"status": "not_found",
"message": "<string>"
}{
"status": "rate_limited",
"message": "<string>"
}{
"status": "error",
"message": "<string>"
}Overview
List the steps of one enrollment in the order they run. Email steps include the copy prepared for that person inemail, so you can review a draft before
approving the enrollment or
edit a step’s copy before
it sends.
To export steps across many enrollments, use
Query enrollment steps.
Examples
Review the copy prepared for a person
Review the copy prepared for a person
Set Each email step returns its current
UNIFY_API_KEY to your API key and replace the example enrollment ID:curl --request GET \
--url "https://api.unifygtm.com/sequences/v1/enrollments/a8b35494-e82e-4a0c-9b8f-0b80c5b5d8f2/steps" \
--header "X-Api-Key: $UNIFY_API_KEY"
subject and body. While
email.is_ready is false, Unify is still preparing the copy and body can
be null. Save each step’s id and email.version_id if you plan to edit
the copy.⌘I