List steps

GET /sop/:name/:id/steps

Returns the state of every step in a process instance. Useful for tracking progress, debugging failures, and building status UIs.

AUTH —

Requires X-SOP-Token header. See Authentication.

Path parameters

name string REQUIRED: The process name.
id string REQUIRED: The instance ULID.

Response

200 application/json — Array of step state objects.

Errors

404 not_found Instance not found.

curl https://api.opensop.dev/sop/customer-onboarding/01HXYZ_ACME_001/steps \
  -H "X-SOP-Token: $OPENSOP_TOKEN"

const steps = await fetch(
  `https://api.opensop.dev/sop/customer-onboarding/${id}/steps`,
  { headers: { "X-SOP-Token": process.env.OPENSOP_TOKEN } }
).then(r => r.json());

resp = requests.get(
  f"https://api.opensop.dev/sop/customer-onboarding/{id}/steps",
  headers={"X-SOP-Token": os.environ["OPENSOP_TOKEN"]}
)

Net::HTTP.start("api.opensop.dev", use_ssl: true) do |h|
  req = Net::HTTP::Get.new("/sop/customer-onboarding/#{id}/steps")
  req["X-SOP-Token"] = ENV["OPENSOP_TOKEN"]
  puts h.request(req).body
end

RESPONSE 200

[
  {
    "id":      "collect-business-info",
    "type":    "form",
    "state":   "completed",
    "outputs": { "company_name": "Acme Corp" }
  },
  {
    "id":    "review-application",
    "type":  "judgment",
    "state": "active"
  }
]