Skip to content

Get the questionnaire

GET
/api/{referralpartner}/form

Retrieves the complete form structure including all pages, questions, and follow-up sections. Validates that the referral partner is active and the requested form exists. Automatically marks required questions based on form configuration.

Authorizations

Parameters

Path Parameters

referralpartner
required
string

Query Parameters

slug
string

Responses

200

OK

object
agentImageUrl

The image of the ‘agent’ guide for the form

string
nullable
pages

The list of pages in the form

Array<object>
nullable
object
encouragement

A brief encouragement to the user

string
nullable
title

The title of the questionnaire page

string
nullable
hint

A brief hint to the user

string
nullable
layout
object
columns

The number of columns to use to layout the questions

integer format: int32
nullable
columnTemplate

The column template to use to layout the questions, for HTML grids

string
nullable
questions
required

The question(s) asked on this page

Array<object>
object
kind
string
Allowed values: FirstName LastName Email Phone CreditScore OwnershipDemographics BusinessName BusinessType BusinessIndustry YearsInBusiness BusinessNumEmployees BusinessAddress PriorBankruptcy HasBusinessPlan RevenueLastYear RevenueProjected NetProfit RequestedAmount UseOfProceeds FinanceNeededBy PreferredContactMethod PreferredContactTime Collateral BusinessService YesNo CustomText CustomAddress CustomNumber CustomMultiChoice CustomSingleChoice
id

The unique id of the question to be used in the answers object

string
col

The HTML column to put the question into

integer format: int32
nullable
colSpan

How many columns the question should span

integer format: int32
nullable
label

The user-friendly label for the question

string
nullable
placeholder

Default placeholder text for the question, if applicable

string
nullable
isRequired

Whether the question is required

boolean
nullable
defaultValue

The default value given to the backend if no answer is provided

nullable
isLabelAlwaysOn

Whether to show the label continuously

boolean
nullable
minValue

The minimum value allowed for the question, if applicable

integer format: int32
nullable
maxValue

The maximum value allowed for the question, if applicable

integer format: int32
nullable
prefix

The prefix for the question, for example a currency symbol

string
nullable
postfix

The postfix for the question, for example a percentage sign

string
nullable
isDollar

Whether or not the numeric value represents a dollar amount

boolean
nullable
isDropdown

Whether or not the options should be displayed as a dropdown or a radio button list

boolean
nullable
minLength

The minimum number of characters allowed

integer format: int32
nullable
maxLength

The maximum allowable length for text input, if applicable

integer format: int32
nullable
options

Dropdown, single-select or multi-select options

Array<object>
nullable
object
id
required

The code-friendly ID of the option

string
label
required

The human-readable label for the option

string
none

The ‘None’ option, if applicable, if the user explicitly wants to unset all other options

string
nullable
followUp
Array<object> recursive
condition
object
question
required

The question to check

string
operator
string
Allowed values: Equals NotEquals GreaterThan LessThan In
value

The value to compare the question’s answer to

results
object
showNextSteps

Hide or show a instructional page before showing matches

boolean
nullable
nextStepsTitle
string
nullable
nextStepsNoMatchTitle
string
nullable
nextStepsNoMoneyTitle
string
nullable
nextStepsBadge
string
nullable
nextStepsSteps
Array<object>
nullable
object
title
string
nullable
description
string
nullable
nextStepsNoMatchSteps
Array<object>
nullable
object
title
string
nullable
description
string
nullable
nextStepsNoMoneySteps
Array<object>
nullable
object
title
string
nullable
description
string
nullable
nextStepsBody
string
nullable
nextStepsNoMatchBody
string
nullable
nextStepsNoMoneyBody
string
nullable
nextStepsAction
string
nullable
nextStepsNoMatchAction
string
nullable
nextStepsNoMoneyAction
string
nullable
loansDescription
string
nullable
grantsDescription
string
nullable
businessServicesDescription
string
nullable
additionalResourcesDescription
string
nullable
showTabs
boolean
nullable
showAPRColumn
boolean
nullable
showLoanTermColumn
boolean
nullable
showCollateralColumn
boolean
nullable
showLoanTypeColumn
boolean
nullable
showApplicationFeeColumn
boolean
nullable
showOriginationFeeColumn
boolean
nullable
showPaymentFrequencyColumn
boolean
nullable
showTimeToFundColumn
boolean
nullable
showPurposeColumn
boolean
nullable
showAwardAmountColumn
boolean
nullable
showOfferedServicesColumn
boolean
nullable
showCostColumn
boolean
nullable
showLocationColumn
boolean
nullable
showOfferDetails
boolean
nullable
showAboutServicePartner
boolean
nullable
showAdditionalResources
boolean
nullable
maxLoans

The maximum number of loans the applicant can select

integer format: int32
nullable
maxBusinessServices

The maximum number of business services the applicant can select

integer format: int32
nullable
maxGrants

The maximum number of grants the applicant can select

integer format: int32
nullable
showReview

Hide or or show a final confirmation page before submitting leads

boolean
nullable
confirmation
object
title
string
nullable
subtitle
string
nullable
nextSteps
Array<object>
nullable
object
title
string
nullable
description
string
nullable
showSentiment
boolean
nullable
matchesTypes

The types of products that can be matched with this form

Array<string>
nullable
Allowed values: Loan Grant BusinessService
shared

Shared setting strings

object
key
additional properties
string
nullable

404

Not Found

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties