Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• form_uuid string Required

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • uuid string

    The UUID of the resource.

  • created_at string

    The timestamp of when the resource was created.

  • updated_at string

    The timestamp of when the resource was updated.

  • section object

    The section this question belongs to

    Hide section attributes Show section attributes object

    • uuid string
    • created_at string
    • updated_at string
    • form object
      Hide form attributes Show form attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • title

        The title of the form

      • description

        The description of the form

      • live

        Whether the form is live

      • visibility

        The visibility of the form

      • allowed_hosts

        Array of allowed domains that this form can be accessed from using different origins

      • draft_submissions_count

        Count of draft submissions against this form

      • submitted_submissions_count

        Count of submitted submissions against this form

      • create_client

        Denotes if this form creates a new client when it is submitted from a public embed

      • client_type

        If create_client is true, then the client_type is the type of client that will be created, possible values are client and prospect

    • title string
    • position integer
    • questions object
      Hide questions attributes Show questions attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • title

        The title of the question

      • help_text

        Input placeholder text

      • caption

        Text to describe the input

      • type

        The type of question

      • required

        Whether the question is required

      • position

        The position of the question in the section

      • selection_options

        The options for selection questions

      • target_field

        The field to update upon question completion

      • key

        The key to use when updating the target field

      • linked_primary

        Will the this linked field become a primary Address/Phone Number/Email Address

  • title string

    The title of the question

  • help_text string

    Input placeholder text

  • caption string

    Text to describe the input

  • type string

    The type of question

  • required boolean

    Whether the question is required

  • position integer

    The position of the question in the section

  • selection_options array[string]

    The options for selection questions

  • target_field string

    The field to update upon question completion

  • key string

    The key to use when updating the target field

  • linked_question object

    the linked form question

    Hide linked_question attributes Show linked_question attributes object

    • type string
    • field string
    • label string
    • formatted_field string
    • selection_options array[string]
    • is_custom_field boolean
    • forced_required boolean
    • caption string
  • linked_primary boolean

    Will the this linked field become a primary Address/Phone Number/Email Address

• 422 application/json

  Validation error

  Hide response attributes Show response attributes object

  • message string Required

    A human-readable description of the error.

  • errors object

    Validation messages keyed by the field that failed.

    Hide errors attribute Show errors attribute object

    • * array[string] Additional properties