Skip to main content

List return options for an instance

GET 
/api/state-machine-instances/:id/return-options

Returns the states the instance can be returned to from its current state, as configured by the current state's return policy: target states, allowed return types, reason codes and any form fields the caller must supply with the return. Returns 404 when the instance does not exist in the caller's organization.

Request​

Responses​

Allowed return targets from the current state; the body is the standard { message, response } envelope, response holds the array