Skip to main content
GET
Get a form

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"

Response

Form and editable definition.

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

"507f1f77bcf86cd799439011"

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

"507f1f77bcf86cd799439011"

name
string
required
status
enum<string>
required
Available options:
draft,
published,
deleted
is_closed
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
type
enum<string>
required

Form presentation model. CONVERSATIONAL is reserved for a future renderer and currently returns 422 UNSUPPORTED_FORM_TYPE when used for creation.

Available options:
SINGLE,
MULTI,
CONVERSATIONAL
definition
object
required