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

Bearer
api-key

Parameters

Path Parameters

referralpartner

required

String

string

Query Parameters

slug

String

string

Responses

200

OutputFormQuestion[]

Array<object>

OutputFormQuestion

object

kind

QuestionType

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

String

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

string

col

Nullable`1

The HTML column to put the question into

integer format: int32

nullable

colSpan

Nullable`1

How many columns the question should span

integer format: int32

nullable

label

String

The user-friendly label for the question

string

nullable

placeholder

String

Default placeholder text for the question, if applicable

string

nullable

isRequired

Nullable`1

Whether the question is required

boolean

nullable

defaultValue

Nullable`1

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

nullable

isLabelAlwaysOn

Nullable`1

Whether to show the label continuously

boolean

nullable

minValue

Nullable`1

The minimum value allowed for the question, if applicable

integer format: int32

nullable

maxValue

Nullable`1

The maximum value allowed for the question, if applicable

integer format: int32

nullable

prefix

String

The prefix for the question, for example a currency symbol

string

nullable

postfix

String

The postfix for the question, for example a percentage sign

string

nullable

isDollar

Nullable`1

Whether or not the numeric value represents a dollar amount

boolean

nullable

isDropdown

Nullable`1

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

boolean

nullable

minLength

Nullable`1

The minimum number of characters allowed

integer format: int32

nullable

maxLength

Nullable`1

The maximum allowable length for text input, if applicable

integer format: int32

nullable

minDate

Nullable`1

The minimum date allowed for the question, if applicable

string format: date

nullable

maxDate

Nullable`1

The maximum date allowed for the question, if applicable

string format: date

nullable

options

List`1

Dropdown, single-select or multi-select options

Array<object>

nullable

OutputFormQuestionOption

object

required

String

The code-friendly ID of the option

string

label

required

String

The human-readable label for the option

string

none

String

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

string

nullable

pattern

String

Specifies a regular expression pattern that the answer must match

string

nullable

format

String

The format to take the number in (i.e. ##-#######)

string

nullable

mask

String

Specifies a regular expression pattern that the answer must match

string

nullable

requireFullNAICS

Nullable`1

Whether the business industry question requires a full NAICS code

boolean

nullable

inputType

InputType

string

Allowed values: Text Tel Email Date DateTime

autocomplete

String

Value of the autocomplete attribute for the input

string

nullable

isMultiline

Nullable`1

Specifies if the input is a multiline textarea

boolean

nullable

404

Not Found

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