Skip to main content

List forms for an instance

GET 
/api/state-machine-instances/forms/:id

Returns the forms attached to the states the instance has reached. Without current_state_id all forms of the flow are returned; with it, only forms up to and including that state. display_on_admin restricts the result to forms flagged for admin display. Returns 404 when the instance does not exist in the caller's organization.

Request​

Responses​

Forms of the instance with their paths; the body is the standard { message, response } envelope, response holds the array