v4

Swagger 2.02026-08-0343714211.7 MB

form_field_sets

Form Field Sets

List Form Field Sets

get/form_field_sets

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

Response

A list of FormFieldSets objects.

idinteger

Form field set id

titlestring

Title to be displayed

form_layoutinteger[]

Layout of the form

skip_nameboolean

Any associated InboxRegistrations or BundleRegistrations can be saved without providing name

skip_emailboolean

Any associated InboxRegistrations or BundleRegistrations can be saved without providing email

skip_companyboolean

Any associated InboxRegistrations or BundleRegistrations can be saved without providing company

in_useboolean

Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration

Example response

[
  {
    "id": 1,
    "title": "Sample Form Title",
    "form_layout": [
      1,
      2,
      3,
      4
    ],
    "form_fields": [
      {
        "id": 1,
        "label": "Sample Label",
        "required": true,
        "help_text": "Help Text",
        "field_type": "text",
        "options_for_select": [
          "red",
          "green",
          "blue"
        ],
        "default_option": "red",
        "form_field_set_id": 1
      }
    ],
    "skip_name": true,
    "skip_email": true,
    "skip_company": true,
    "in_use": true
  }
]