Skip to main content
GET
Retrieve question set for a flow by id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

flowId
string
required
questionSetId
string
required

Query Parameters

includeWarnings
boolean
default:false

When true, includes warning rules for the question set. Warnings are disabled by default.

prioritizeStandardFederalWithholding
boolean
default:false

When true, reorders Federal W-4 survey questions to prioritize Standard Federal Withholding first, followed by Foreign Earned Income Exclusion, then Nonresident Alien Exempt

Response

OK

id
string
notice
object
questions
object[]
breadcrumbTitle
string
copyKey
string

Stable key identifying this question set's breadcrumb title for copy customization. Format: {formId}.{questionSetId}.breadcrumbTitle. Omitted when not applicable.

navigation
object
warningRulesList
object[]
notes
object[]