Skip to content

Get the form client embed script

GET
/api/{referralpartner}/{form}.js

Generates a JavaScript file that can be embedded in a webpage to load the form client. Includes configuration for public URL, referrer information, and optional form name and referral code. Implements caching with ETag support and includes necessary CORS headers.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
referralpartner
required
String
string
default: sample-referrer
form
required
String
string
default: embed

Query Parameters

Section titled “Query Parameters ”
referralCode
String
string

Header Parameters

Section titled “Header Parameters ”
If-None-Match
String
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

304

Section titled “304 ”

Not Modified

500

Section titled “500 ”

Internal Server Error

ProblemDetails
object
type
String
string
nullable
title
String
string
nullable
status
Nullable`1
integer format: int32
nullable
detail
String
string
nullable
instance
String
string
nullable
key
additional properties
Object