Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[live] boolean

  Get forms that have or have not been published.

• filter[visibility] string

  Get forms of this visibility value, Available types are 'hidden', 'public', 'private', and 'internal'.

• filter[title] string

  Get forms with a title that match this filter.

• filter[created_after] string

  Date to filter when the record was created after.

• filter[created_before] string

  Date to filter when the record was created before.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, title]. Negative sign to denote DESC. Defaults to '-created_at'.

• per_page integer

  Number of results to return with pagination (Default 15. Max 500).

Responses

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

  • data array[object]
    Hide data attributes Show data 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.

    • title string

      The title of the form

    • description string

      The description of the form

    • live boolean

      Whether the form is live

    • visibility string

      The visibility of the form

    • sections object

      The sections of the form. They include the forms questions in a array

      Hide sections attributes Show sections attributes object

      • uuid string
      • created_at string
      • updated_at string
      • section string
      • title string
      • help_text string
      • caption string
      • type string
      • required boolean
      • position integer
      • selection_options array[string]
      • target_field string
      • key string
      • linked_question string
      • linked_primary boolean
    • allowed_hosts array[string]

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

    • draft_submissions_count integer

      Count of draft submissions against this form

    • submitted_submissions_count integer

      Count of submitted submissions against this form

    • create_client boolean

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

    • client_type string

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