Skip to main content
GET
Get a form block

Authorizations

X-API-Key
string
header
required

A scoped key with the of_live_ prefix, generated from Profile > API keys.

Path Parameters

formId
string
required
Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439011"

blockId
string
required

Stable caller-supplied ID of a top-level block.

Required string length: 1 - 200

Response

Block details.

id
string
required

Stable caller-supplied block ID.

type
enum<string>
required
Available options:
welcome,
ending,
date,
file-upload,
phone-number,
email,
website,
payment,
statement,
group,
short-text,
long-text,
ranking,
opinion-scale,
rating,
matrix,
number,
multiple-choice,
picture-choice,
yes-no,
dropdown,
legal,
address,
contact-info,
time,
color,
currency,
slider,
gate,
signature,
coordinates,
captcha,
video,
pdf,
text,
divider,
label,
heading-1,
heading-2,
heading-3,
page-break,
logic,
hidden-field,
image,
audio,
checkboxes
label
string
required
description
string
required
required
boolean
required
properties
object
required

Type-specific block settings. Unsupported combinations are ignored by the renderer.

part_of
string
row_id
string
choices
object[]
children
array
matrix_columns
object[]
matrix_rows
object[]