Skip to content
Elara One docs
Forms

Get a form

GET
/v1/forms/{handle}

Authorization

tenantKey
headerX-Tenant-Key<token>

The public store key (pk_live_…). Required on every call.

Path Parameters

handle*string

Header Parameters

X-Client-IP?string

Optional. IP address of the shopper (one IPv4/IPv6, no port, no list). Honoured only together with a valid X-Tenant-Secret; ignored otherwise. Used for rate limits and recorded with form submissions.

X-Tenant-Secret?string

Optional here. Server secret of the store: server-to-server only, never from a browser. Enables X-Client-IP.

Response Body

Success.

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.elaraone.app/api/v1/forms/string' \  -H 'X-Tenant-Key: pk_live_…' \  -H 'X-Tenant-Secret: your-server-secret'
Example Response
{  "data": {    "handle": "string",    "name": "string",    "fields": [      {        "handle": "string",        "type": "string",        "label": "string",        "required": true,        "options": [          "string"        ],        "rules": [          "string"        ],        "constraints": {          "min_length": 0,          "max_length": 0,          "min": 0,          "max": 0        },        "marketing_consent": true,        "accept": {          "mime_types": [            "string"          ],          "extensions": [            "string"          ]        },        "max_files": 0,        "max_size_bytes": 0,        "upload_url": "string"      }    ],    "captcha": null  }}