Fetch an enrollment (step pointer, created orders, next action)

GET

/v1/enrollments/{enrollment_id}

curl https://api.pacepayments.ai/v1/enrollments/enr_01J40H7S \
  --header 'Authorization: Bearer <token>'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.pacepayments.ai/v1/enrollments/enr_01J40H7S");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  requestUrl := "https://api.pacepayments.ai/v1/enrollments/enr_01J40H7S"

  req, _ := http.NewRequest("GET", requestUrl, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.pacepayments.ai/v1/enrollments/enr_01J40H7S")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

Authorizations

pace_oauth2
orders:read

Parameters

Path Parameters

enrollment_id

required

Enrollment Id

string

Responses

200

Successful Response

application/json

Enrollment

object

required

string

sequence_id

required

Sequence Id

string

sequence_key

required

Sequence Key

string

sequence_version

required

Sequence Version

Pinned at enrollment; never changes. Activating a new version leaves running enrollments untouched.

integer

>= 1

status

required

Status

string

Allowed values: active paused completed exited canceled failed

exit_reason

Any of:

string
null

string

subject_reference

required

Subject Reference

string

triggered_by_signal_id

Any of:

string
null

string

current_step_id

Any of:

string
null

string

next_action_at

Any of:

string
null

string format: date-time

call_order_ids

Call Order Ids

The orders this ladder created - oldest first. Retrievable via GET /v1/call-orders?enrollment_id=….

Array<string>

metadata

Any of:

object
null

Your own opaque key-value pairs; mirrored on resources and in every event. CONTRACTUALLY free of personal data - Pace does not inspect the values. Whatever you put here falls outside the deletion and retention machinery that protects the rest of the order.

object

key

additional properties

any

created_at

required

Created At

string format: date-time

ended_at

Any of:

string
null

string format: date-time

Example

{
  "id": "enr_01J40H7S",
  "status": "active",
  "metadata": {
    "campaign": "q3-onboarding",
    "cost_center": "77"
  }
}

401

No valid access token. Client action: request a new token from the token endpoint and retry once. Repeated 401 with a fresh token means the client registration is disabled - contact Pace, do not retry in a loop.

application/problem+json

Problem

object

type

required

Type

string

title

required

Title

string

status

required

Status

integer

code

required

Code

string

detail

Any of:

string
null

string

instance

Any of:

string
null

string

trace_id

Any of:

string
null

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

pointer

required

Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string

code

required

Code

Stable field error code (open registry).

string

message

Any of:

string
null

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "trace_id": "example",
  "errors": [
    {
      "pointer": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

403

Authenticated but not permitted. insufficient_scope names the missing scope in detail; feature_not_enabled means the tenant lacks the feature; ip_not_allowlisted means the source IP is not on the client registration’s allowlist; simulate_not_allowed means a sandbox-only simulate block was sent to the live host. None of these are retryable.

application/problem+json

Problem

object

type

required

Type

string

title

required

Title

string

status

required

Status

integer

code

required

Code

string

detail

Any of:

string
null

string

instance

Any of:

string
null

string

trace_id

Any of:

string
null

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

pointer

required

Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string

code

required

Code

Stable field error code (open registry).

string

message

Any of:

string
null

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "trace_id": "example",
  "errors": [
    {
      "pointer": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

HTTP rate limit (rate_limited) or execution capacity refusal (quota_exceeded, backlog_full) - two distinct layers. Wait for Retry-After, then retry the identical request with the same Idempotency-Key. backlog_full will not clear in seconds; back off to minutes.

application/problem+json

Problem

object

type

required

Type

string

title

required

Title

string

status

required

Status

integer

code

required

Code

string

detail

Any of:

string
null

string

instance

Any of:

string
null

string

trace_id

Any of:

string
null

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

pointer

required

Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string

code

required

Code

Stable field error code (open registry).

string

message

Any of:

string
null

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "trace_id": "example",
  "errors": [
    {
      "pointer": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

Headers

Retry-After

integer

Seconds until the next attempt is permitted.

RateLimit-Limit

integer

RateLimit-Remaining

integer

RateLimit-Reset

integer

default

Error (RFC 9457). Branch on code, never on title or detail.

application/problem+json

Problem

object

type

required

Type

string

title

required

Title

string

status

required

Status

integer

code

required

Code

string

detail

Any of:

string
null

string

instance

Any of:

string
null

string

trace_id

Any of:

string
null

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

object

pointer

required

Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string

code

required

Code

Stable field error code (open registry).

string

message

Any of:

string
null

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "trace_id": "example",
  "errors": [
    {
      "pointer": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

Fetch an enrollment (step pointer, created orders, next action)

Authorizations

Parameters

Path Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

422

Examplegenerated

429

Examplegenerated

Headers

default

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated