/bff/form/structure

Returns the full form definition including metadata and all field definitions. Used by the form builder to load and edit the form layout.

FormgetBffFormStructure

Parameters

1 query

1 total

Query · 1

codestringRequired

Form code.

Request

GET /bff/form/structure

get

curl -X GET "https://api.bizkithub.com/bff/form/structure?code=contact-form" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "info": {
    "name": "example_name",
    "code": "example_code",
    "active": false,
    "description": "example_description"
  },
  "fields": [
    {
      "key": "example_key",
      "parentKey": "example_parentKey",
      "label": "example_label",
      "helperText": "example_helperText",
      "required": false,
      "defaultValue": "example_defaultValue",
      "position": 0,
      "active": false
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key