Get form details

GET

/cms/form/{id}

const url = 'https://api.example.com/cms/form/1';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.example.com/cms/form/1 \
  --header 'API-Key: <API-Key>'

Returns details of a specific form.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

integer

Responses

200

Form details

application/json

Form

API representation of a form

object

Form ID

name

Form name

string

fields

Fields

Array<object>

object

captcha_enabled

Captcha enabled

allow_anonymous

Allow anonymous submissions

Example ^generated

{
  "id": "example",
  "name": "example",
  "fields": [
    {}
  ],
  "captcha_enabled": "example",
  "allow_anonymous": "example"
}

401

Form not available

404

Form not found