List all instances

GET /sop/instances

Returns a paginated list of instances across all processes. Filter by process name or state to narrow results.

AUTH —

Requires X-SOP-Token header. See Authentication.

Query parameters

process string OPTIONAL: Filter to a specific process name.
state enum OPTIONAL: One of: pending, running, completed, failed, cancelled.

Response

200 application/json — Paginated list of instance objects.

Errors

401 unauthorized Token missing or revoked.

curl "https://api.opensop.dev/sop/instances?state=running" \
  -H "X-SOP-Token: $OPENSOP_TOKEN"

const res = await fetch(
  "https://api.opensop.dev/sop/instances?state=running",
  { headers: { "X-SOP-Token": process.env.OPENSOP_TOKEN } }
);

resp = requests.get(
  "https://api.opensop.dev/sop/instances",
  params={"state": "running"},
  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/instances?state=running")
  req["X-SOP-Token"] = ENV["OPENSOP_TOKEN"]
  puts h.request(req).body
end

RESPONSE 200

[
  {
    "id":         "01HXYZ...",
    "process":    "customer-onboarding",
    "state":      "running",
    "started_at": "2024-01-15T10:30:00Z"
  }
]