Skip to main content
GET
Get a form

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Path Parameters

formId
string
required

Response

Tenant-scoped resource.

Public form configuration only. Internal webhook, credential, provider, and workflow fields are excluded.

id
string
required
name
string
required
description
string | null
required
published
boolean
required
fields
object[]
required
contactListId
string | null
required
publicTitle
string | null
required
publicDescription
string | null
required
heroImageUrl
string | null
required
openGraphTitle
string | null
required
openGraphDescription
string | null
required
openGraphImageUrl
string | null
required
successTitle
string | null
required
successMessage
string | null
required
successImageUrl
string | null
required
successButtonText
string | null
required
successButtonUrl
string | null
required
maxSubmissionsPerUser
integer | null
required
showVouchersOnCompletion
boolean
required
termsMode
string
required
customTerms
string | null
required
requireEmailVerification
boolean
required
shortUrl
string | null
required
notificationEmails
string[]
required
createdAt
string<date-time>
required

UTC ISO 8601 timestamp.

updatedAt
string<date-time>
required

UTC ISO 8601 timestamp.