Forms

Get Form Preview

One placement preview: its state and, once captured, where the image is.

get/forms/{form_key}/preview/{preview_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/forms/{form_key}/preview/{preview_id}
  • Auth: HTTP bearer

Path parameters

form_keystring required

The form's form_key (the id from GET /forms).

preview_idstring required

Id from the capture that started it.

Query parameters

source_idstring required

The site (write key) the form is installed on.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataFormsAdminPayload required

One forms object, or one handler response.

Open-shaped: the submission, mapping, group and audit payloads grow with the product, and a closed model here would silently drop what it does not name.

Changes

No recorded changes to this operation across all 2 revisions of this API.