Skip to main content
POST
entity.get

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
jsonrpc
string
required
Allowed value: "2.0"
method
string
required
Allowed value: "entity.get"
id

Client-chosen request id, echoed in the response.

params
object

Response

200 - application/json

JSON-RPC response envelope.

jsonrpc
string
Allowed value: "2.0"
id
result
object

Entity-native shape: typed fields, gates, accumulator state. This is the destination shape entity.get returns. v1 implementation may need to translate from the existing instance-shaped readers in internal/dashboard/server/server.go (which return flat WorkflowInstance structs without the typed-fields/gates/ accumulated decomposition). The spec commits to the entity-native shape; implementations are responsible for providing it. A real entity-read owner may need to land before entity.* methods can honor this shape, which is why the entity.* methods are should_have rather than must_have for v1.