Fetch a sequence incl. versions

GET

/v1/sequences/{sequence_id}

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

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.pacepayments.ai/v1/sequences/seq_01J40G4Q");
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/sequences/seq_01J40G4Q"

  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/sequences/seq_01J40G4Q")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

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

Authorizations

pace_oauth2
config:read

Parameters

Path Parameters

sequence_id

required

Sequence Id

string

Responses

200

Successful Response

application/json

Sequence

object

required

string

key

required

Key

string

title

required

Title

string

status

required

Status

string

Allowed values: draft active archived

active_version

Any of:

integer
null

integer

versions

required

Versions

Array<object>

>= 1 items

SequenceVersion

object

trigger

required

SequenceTrigger

object

signal_type

required

Signal Type

Your own taxonomy (dot.case). Three types the platform interprets itself, and each stops a sequence: payment.received, claim.withdrawn, claim.disputed.

string

>= 3 characters <= 64 characters /^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)+$/

enrollment_policy

Enrollment Policy

There is deliberately NO allow_parallel: running two ladders against the same person at once only raises contact pressure, and that is the one thing this field must not be there for.

string

default: one_active_per_subject

Allowed values: one_active_per_subject replace_active

exit_conditions

Exit Conditions

Array<object>

ExitCondition

When a ladder is broken off.

suppression is always implicitly present - a do-not-call entry stops every sequence whether or not it is listed here. You may still write it out, for clarity.

object

type

required

Type

string

signal_type

Any of:

string
null

string

<= 64 characters

steps

required

Steps

Array

One of: discriminator: type

WaitStep

Hold - and no longer than the calling window permits.

The computed instant is intersected with the statutory calling window at EXECUTION time. The actual wake-up may therefore fall later than after.max. That is not imprecision; it is the rule that lets client configuration narrow the window and never widen it.

object

required

A stable step identifier, unique within a sequence version.

string

/^[a-z][a-z0-9_]{0,63}$/

type

required

Type

string

Allowed value: wait

after

Any of:

WaitAfter
null

WaitAfter

object

min

Any of:

string
null

ISO-8601 duration, days/hours/minutes only (no months or years - those have no fixed length, and a wait window that varies by month is not a wait window).

string

/^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?)?$/

max

Any of:

string
null

ISO-8601 duration, days/hours/minutes only (no months or years - those have no fixed length, and a wait window that varies by month is not a wait window).

string

/^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?)?$/

until

Any of:

WaitUntil
null

WaitUntil

object

date

Date

null

local_time

Any of:

string
null

Lokale Wanduhrzeit, 24 h, fuehrende Null.

string

/^([01]\d|2[0-3]):[0-5]\d$/

skip_remaining_if

Skip Remaining If

Array<object>

<= 10 items

ExitCondition

When a ladder is broken off.

suppression is always implicitly present - a do-not-call entry stops every sequence whether or not it is listed here. You may still write it out, for clarity.

object

type

required

Type

string

signal_type

Any of:

string
null

string

<= 64 characters

CallStep

CREATE an order and wait for its result.

The step does not dial by itself. It creates an ordinary call order that runs the full Model A lifecycle and emits the same events as one you submitted directly - which is why Model B has no second dial path and no second result derivation.

object

required

A stable step identifier, unique within a sequence version.

string

/^[a-z][a-z0-9_]{0,63}$/

type

required

Type

string

Allowed value: call

order_type

required

Order Type

string

>= 2 characters <= 64 characters /^[a-z][a-z0-9_]{1,63}$/

scheduling

Any of:

Scheduling
null

Scheduling

object

window

Any of:

SchedulingWindow
null

SchedulingWindow

object

not_before

Any of:

string
null

string format: date-time

not_after

Any of:

string
null

string format: date-time

local_call_times

Any of:

Array<object>
null

Array<object>

<= 7 items

LocalCallTime

A window in the timezone of the person BEING CALLED, not ours.

object

days

required

Days

Array<string>

>= 1 items <= 7 items

Allowed values: mon tue wed thu fri sat sun

from

required

From

Lokale Wanduhrzeit, 24 h, fuehrende Null.

string

/^([01]\d|2[0-3]):[0-5]\d$/

required

Lokale Wanduhrzeit, 24 h, fuehrende Null.

string

/^([01]\d|2[0-3]):[0-5]\d$/

max_attempts

Max Attempts

integer

default: 3 >= 1 <= 10

retry

Any of:

RetryPolicy
null

RetryPolicy

object

min_gap_hours

Min Gap Hours

Minimum gap between two attempts against the same person.

number

default: 24 >= 1

randomize_within_window

Randomize Within Window

Scatters the redial instant within the permitted window, so the same person is not called at the same minute every day.

boolean

default: true

retry_on

Retry On

Only unreached attempts can trigger a retry. A conversation that actually took place is never a reason to call again.

Array<string>

on_window_violation

On Window Violation

What happens when your window and the permitted window do not intersect: defer moves the order into the permitted window (and the order may end up expired), reject refuses acceptance with a 422.

string

default: defer

Allowed values: defer reject

negotiation

Any of:

Negotiation
null

Negotiation

The decision corridor. The agent never goes beyond it.

object

installments

Any of:

InstallmentPolicy
null

InstallmentPolicy

object

allowed

Any of:

boolean
null

boolean

max_count

Any of:

integer
null

integer

>= 2 <= 24

min_installment

Any of:

Money
null

Money

object

value

required

Value

An exact decimal, as a string - no float drift.

string

/^-?\d+(\.\d{1,2})?$/

currency

required

Currency

ISO 4217.

string

/^[A-Z]{3}$/

conclusion_mode

Conclusion Mode

The agent RECORDS THE WISH. It concludes nothing - the binding agreement is one you make afterwards, in writing. There is deliberately no second value.

string

default: record_wish_only

Allowed value: record_wish_only

settlement

Any of:

SettlementPolicy
null

SettlementPolicy

object

allowed

Any of:

boolean
null

boolean

min_ratio

Any of:

number
null

number

<= 1

conclusion_mode

Conclusion Mode

string

default: record_wish_only

Allowed value: record_wish_only

promise_to_pay

Any of:

PromiseToPayPolicy
null

PromiseToPayPolicy

object

allowed

Any of:

boolean
null

boolean

max_days

Any of:

integer
null

integer

>= 1 <= 90

payment_rails

Any of:

Array<string>
null

Array<string>

ExitStep

object

required

A stable step identifier, unique within a sequence version.

string

/^[a-z][a-z0-9_]{0,63}$/

type

required

Type

string

Allowed value: exit

reason

Reason

Recorded verbatim as the enrollment’s exit_reason.

string

default: ladder_exhausted <= 64 characters

version

required

Version

integer

>= 1

status

required

Status

Only a draft can be activated, and an active version is immutable. At most one is active.

string

Allowed values: draft active archived

created_at

required

Created At

string format: date-time

activated_at

Any of:

string
null

string format: date-time

created_at

required

Created At

string format: date-time

updated_at

Any of:

string
null

string format: date-time

Example

{
  "id": "seq_01J40G4Q",
  "status": "draft",
  "versions": [
    {
      "trigger": {
        "signal_type": "payment.received",
        "enrollment_policy": "one_active_per_subject"
      },
      "exit_conditions": [
        {
          "type": "signal"
        }
      ],
      "steps": [
        {
          "id": "wait_settle",
          "type": "wait",
          "after": {
            "min": "PT2H",
            "max": "PT2H"
          },
          "until": {
            "local_time": "09:00"
          },
          "skip_remaining_if": [
            {
              "type": "signal"
            }
          ]
        }
      ],
      "status": "draft"
    }
  ]
}

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 a sequence incl. versions

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