/api/v1/form/detail

Returns form definition with all active fields, their types, labels, and validation rules. Throws PUBLIC_FORM_DOES_NOT_EXIST if the form is not found or inactive.

formgetApiV1FormDetail

Parameters

2 query

2 total

Query · 2

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

codestring

Unique form code identifier.

Request

GET /api/v1/form/detail

get

curl -X GET "https://api.bizkithub.com/api/v1/form/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&code=contact-form" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Form definition.

{
  "id": "contact-form",
  "name": "Contact Form",
  "description": "example_description",
  "fields": [
    {
      "key": "email",
      "type": "text",
      "label": "Your email",
      "helperText": "example_helperText",
      "required": false,
      "defaultValue": "example_defaultValue",
      "options": {}
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key