Skip to main content
GET
Show a form outline
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

form_id
string
required

Unique ID of the form. Refer to Getting the Form ID for detailed instructions.

Query Parameters

draft
boolean
default:false

Include unpublished changes. Without it, a published form is outlined as it is live, without its pending changes. Required for a form that has never been published.

Response

OK - Request succeeded

outline
string

The outline as plain text, one line per element.