Skip to content

Get the questionnaire questions

GET
/api/{referralpartner}/form/questions

Retrieves a flattened list of all questions from the form, excluding client-only and hidden questions. Validates partner status and form existence. Questions are marked as required based on form configuration and question type.

Authorizations

Parameters

Path Parameters

referralpartner
required
string

Query Parameters

slug
string

Responses

200

OK

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

404

Not Found

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