formats

Get Wizard Format Boards List

get/v3.0/formats/{formatSlug}/boards/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/formats/{formatSlug}/boards/
  • Auth: none declared. Required headers: x-api-key

Path parameters

formatSlugstring required

Query parameters

searchstring

A search query on the list items.

tagsstring
template_typestring
versionstring

Headers

x-api-keystring required

The application secret provided to the client.

x-workspacestring

The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.

Response

tagsstring[]

tags's slug.

excerptstring nullable

an optional excerpt on the board to be searched on.

white_labelstring
full_board_addressstring
form_visit_countstring

shows the visit count of the board's main form if it has exactly one form.

form_submit_countstring

shows the submit count of the board's main form if it has exactly one form.

created_atstring date-time
updated_atstring date-time
slugstring
is_primaryboolean

shows if this board is the primary board for the primary form.

is_publicboolean

shows if this board can be displayed publicly.

is_templateboolean

shows if this board can be used as a template.

template_type'board' | 'form'
titlestring nullable

an optional short title to identify the board by.

descriptionstring nullable

an optional description on the board.

share_addressstring nullable

an auto-generated address to share the board with.

configobject nullable
theme_configobject nullable
copy_infoobject
thumbnail_urlstring

the thumbnail's url.

banner_slugstring nullable

the banner's slug.

banner_urlstring

the banner's url.

logo_slugstring nullable

the logo's slug.

logo_urlstring

the logo's url.

icon_slugstring nullable

the icon's slug.

icon_urlstring nullable

the icon's url.

custom_domainstring nullable

user can set this on the board, if they want to show this board on a custom domain (e.g. https://example.co/).

versionstring

version of board

custom_cssstring nullable

enter custom css to be applied to board. this CSS will not be sanitized.

custom_jsstring nullable

enter custom js to be run in board. this js will not be sanitized.

user_forminteger nullable
primary_forminteger nullable

the primary form related to this board.

folderinteger nullable
templateinteger nullable

the template related to this board.

copied_frominteger

if the board is copied from another board, shows the source board.

Changes

No recorded changes to this operation across all 1 revision of this API.