Skip to content

GET /api/v1/lifecycles/{entity_name}/{guid}/state

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Get State

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/lifecycles/<entity_name>/<guid>/state" \
-H "Authorization: Bearer <token>"

The contract carries no example for this response; schema: LifecycleStateResponse. Field-level shape: interactive explorer.

LifecycleStateResponse — Successful Response

FieldTypeDescription
available_outletsarray of OutletDef (opt.)
current_stepStepDef | null (opt.)
entitystring
guidinteger
is_terminalboolean (opt.)
last_logLifecycleLogRead | null (opt.)
lcidinteger | null
lcstepinteger | null
locked_bystring | null (opt.)
permitted_manual_stepsarray of StepDef (opt.)
ParameterInRequiredTypeDefaultConstraintsDescription
entity_namepathyesstring——
guidpathyesinteger——
CodeMeaningBody
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.