List enrollments

cURL

curl --request GET \
  --url https://api.unifygtm.com/sequences/v1/enrollments \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.unifygtm.com/sequences/v1/enrollments', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/sequences/v1/enrollments")

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

{
  "enrollments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "sequence": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "is_paused": true
      },
      "person": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "first_name": "<string>",
        "last_name": "<string>",
        "linkedin_url": "<string>"
      },
      "mailbox": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "display_name": "<string>",
        "is_paused": true,
        "is_unauthorized": true
      },
      "enrolled_by_play": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "reply_email_message": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "subject": "<string>",
        "classifications": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "category": "AUTOMATED"
          }
        ],
        "received_at": "2023-11-07T05:31:56Z"
      },
      "status": "DRAFT",
      "is_blocked": true,
      "is_bounced": true,
      "is_canceled": true,
      "is_excluded": 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"
    }
  ],
  "next_cursor": "<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>"
}

GET

sequences

enrollments

cURL

curl --request GET \
  --url https://api.unifygtm.com/sequences/v1/enrollments \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.unifygtm.com/sequences/v1/enrollments', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/sequences/v1/enrollments")

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

{
  "enrollments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "sequence": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "is_paused": true
      },
      "person": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "first_name": "<string>",
        "last_name": "<string>",
        "linkedin_url": "<string>"
      },
      "mailbox": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "display_name": "<string>",
        "is_paused": true,
        "is_unauthorized": true
      },
      "enrolled_by_play": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "reply_email_message": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "subject": "<string>",
        "classifications": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "category": "AUTOMATED"
          }
        ],
        "received_at": "2023-11-07T05:31:56Z"
      },
      "status": "DRAFT",
      "is_blocked": true,
      "is_bounced": true,
      "is_canceled": true,
      "is_excluded": 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"
    }
  ],
  "next_cursor": "<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

Inspect a person’s enrollments or check progress in a sequence. Combine filters to narrow the results. Use a query job for bulk exports.

Examples

Check a person's active enrollments

Set UNIFY_API_KEY to your API key. Replace the example IDs with records from your workspace.

curl --request GET \
  --url "https://api.unifygtm.com/sequences/v1/enrollments?person_id=bf3f4d5e-c995-496f-8774-5a1c58d05197&status=IN_PROGRESS&limit=100" \
  --header "X-Api-Key: $UNIFY_API_KEY"

Inspect is_paused on each enrollment to distinguish paused work from work that can progress. To check a whole sequence, replace person_id with sequence_id.

Retrieve recent changes

Use updated_after and updated_before to bound the enrollment’s updated_at timestamp. Both bounds are inclusive. When syncing changes to another system, use enrollment IDs to update existing rows if successive time windows overlap. For a larger export, use Query enrollments.

Authorizations

x-api-key

string

header

required

Query Parameters

cursor

string

Opaque cursor returned by the previous page.

limit

integer

Required range: 1 <= x <= 100

sequence_id

string<uuid>

String UUID value.

person_id

string<uuid>

String UUID value.

mailbox_id

string<uuid>

String UUID value.

enrolled_by_play_id

string<uuid>

Filter to enrollments created by this play. String UUID value.

status

enum<string>[]

Repeat status to filter by multiple enrollment statuses.

Status of a sequence enrollment.

Available options:

DRAFT,

IN_PROGRESS,

FINISHED

updated_after

string<date-time>

Inclusive lower bound on updated_at. String value representing an RFC 3339 datetime.

updated_before

string<date-time>

Inclusive upper bound on updated_at. String value representing an RFC 3339 datetime.

Response

Response returned when listing enrollments.

enrollments

object[]

required

Show child attributes

next_cursor

string | null

required

⌘I

Unify platform

MCP

Developer guides

API reference

SDKs

List enrollments

Overview

Examples

Retrieve recent changes

Authorizations

Query Parameters

Response

​Overview

​Examples

​Retrieve recent changes

Authorizations

Query Parameters

Response

Overview

Examples

Retrieve recent changes