> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetoform.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Show a form outline

> Show a compact text outline of the form as respondents see it: the theme (font, background, question and answer colors, background image, card, buttons and text alignment), every element in order with its kind, required mark, placeholder and options, the conditional logic in plain words, and the thank-you page. Each form element line (the welcome screen and every question, but not the submit button) ends with that element's own selector, `[id="<uuid>"]`, which a theme's `custom_css` can target. It is meant for AI agents and scripts that cannot open the form in a browser.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace’s subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](https://apidocs.neetoform.com/api/workspace-subdomain.md).


## OpenAPI

````yaml bundled/forms.yaml GET /forms/{form_id}/outline
openapi: 3.0.3
info:
  title: NeetoForm APIs
  version: 2.0.0
servers:
  - description: NeetoForm APIs
    url: https://{your-subdomain}.neetoform.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
paths:
  /forms/{form_id}/outline:
    get:
      tags:
        - Forms
      summary: Show a form outline
      description: >-
        Show a compact text outline of the form as respondents see it: the theme
        (font, background, question and answer colors, background image, card,
        buttons and text alignment), every element in order with its kind,
        required mark, placeholder and options, the conditional logic in plain
        words, and the thank-you page. Each form element line (the welcome
        screen and every question, but not the submit button) ends with that
        element's own selector, `[id="<uuid>"]`, which a theme's `custom_css`
        can target. It is meant for AI agents and scripts that cannot open the
        form in a browser.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/form_id_param'
        - in: query
          name: draft
          required: false
          description: >-
            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.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  outline:
                    type: string
                    description: >-
                      The outline as plain text, one line per element. Each
                      element line ends with a CSS selector for that element.
              example:
                outline: >-
                  Form "Riverside Roasters Wholesale Application" (published,
                  single page)

                  Theme: font Lora; background #F6EFE4; background image
                  roast.jpg (center, lighter 30%); card #FBF7F0E6; questions
                  #000000; answers #3E5641; button #3E5641, text #FFFFFF, radius
                  24px; thank-you text aligned center

                  1. Welcome screen "Partner with Riverside Roasters" (button
                  "Apply now") [id="0b7e4c52-8d1a-4f36-9a0e-5c2d7b9e1f48"]

                  2. "Work email" email, required, placeholder
                  "you@yourcafe.com" [id="3f9a6d17-2c84-4e5b-b1a3-7e0d8c4a9526"]

                  3. "What kind of business is it?" dropdown, required, options:
                  Cafe or coffee bar | Restaurant | Grocery or deli | Something
                  else [id="a2c5e801-6b3f-4d97-8e14-0f7a9b3c6d52"]

                  4. "Tell us a little about it" text_input, hidden until a rule
                  shows it [id="d4816f3a-90e2-4b7c-a5d8-1c3e6f9b2a07"]

                  5. Submit button "Send application"

                  Logic:

                  - Show "Tell us a little about it" when "What kind of business
                  is it?" is "Something else"

                  Thank-you page: Thanks, we are on it.
        '404':
          description: Not Found - The form does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: Form does not exist.
        '422':
          description: >-
            Unprocessable Entity - The form has never been published and `draft`
            is not `true`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: >-
                  The form "Contact us" has never been published. Pass draft:
                  true to preview it
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    form_id_param:
      in: path
      name: form_id
      description: >-
        Unique ID of the form. Refer to [Getting the Form
        ID](/api/getting-form-id) for detailed instructions.
      required: true
      schema:
        type: string
  schemas:
    error_response:
      type: object
      properties:
        error:
          type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.