BizKitHub
DocsAPI ReferenceForm/bff/form/structure
getFormAdmin BFF

/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

Query parameters

· 1
codestringRequired

Form code.

Examplecontact-form

Response schema

1 status code documented

200Success
infoobjectRequired
namestringRequired

Form name.

codestringRequired

Form code (URL-friendly slug).

activebooleanRequired

Whether the form is active.

descriptionstringOptional

Form description.

fieldsobject[]Required
Each array item:
keystringRequired

Unique field key within the form.

parentKeystringOptional

Parent field key (for nested fields).

type"header" | "text" | "textarea" | "date" | "number" | "boolean" | "select"Required

Field input type.

labelstringRequired

Field label displayed to the user.

helperTextstringOptional

Additional help text below the field.

requiredbooleanRequired

Whether the field is required.

defaultValuestringOptional

Default value for the field.

optionsanyOptional

Options for select/radio/checkbox fields (key-value pairs).

positionnumberRequired

Display order (1-based).

activebooleanRequired

Whether the field is active.

insertedDateDate | string | string | numberRequired

When the field was created.

One of 4:
Variant 1
Date

When the field was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired

Last update.

One of 4:
Variant 1
Date

Last update.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "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
    }
  ]
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key