BizKitHub
DocsInteractive API Docs/api/v1/form/detail
get

/api/v1/form/detail

API endpoint documentation

Endpoint Info
Base URLapi.bizkithub.com
AuthBearer Token
Methods1
Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

2 query parameters

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

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/form/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&code=example_code", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);
get

Example Response

200Success
{
  "id": "example_id",
  "name": "example_name",
  "description": "example_description",
  "fields": [
    {
      "key": "example_key",
      "type": "example_type",
      "label": "example_label",
      "helperText": "example_helperText",
      "required": false,
      "defaultValue": "example_defaultValue",
      "options": {}
    }
  ]
}

cURL

Command line example

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

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference