coldos
API key

The key never leaves your browser. Saved keys are stored in this browser's localStorage so paste-once-run-anywhere works across the portal.

GET/v1/enrollments/{id}flows:read

Retrieve an enrollment

Run a request

GET/v1/enrollments/{id}
idrequired

GEThttps://coldos.justgotwyrd.com/api/v1/enrollments/{id}

Paste an API key in the bar at the top of the page to enable Execute.

Parameters

Path parameters

  • idstringrequired

    Enrollment id.

Responses

  • 400Invalid request — see `error.message`.
  • 401Missing or invalid API key.
  • 403Authenticated, but the key lacks the required scope.
  • 404The referenced resource does not exist or is not visible to your key.
  • 429Rate limit exceeded — see `Retry-After`.
  • 500Unexpected server error. Safe to retry with idempotency-key.

Code samples

curl -X GET "https://coldos.justgotwyrd.com/api/v1/enrollments/{id}" \
  -H "Authorization: Bearer $COLD_OS_API_KEY"
Response · 200
{
  "id": "01HZS3K8YV0E5Q9P2R7XJF6E2B",
  "flow_id": "01HZS1Q4XK9R2YQX9F7F1ZQE3T",
  "contact_id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
  "status": "active",
  "current_node_id": "node_email_2",
  "next_run_at": "2026-05-02T09:00:00.000+05:30",
  "enrolled_by": "b1f2c3d4-5678-90ab-cdef-1234567890ab",
  "enrolled_at": "2026-04-30T12:15:00.000+05:30",
  "exit_reason": null
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.