List Questions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Conditional questions

Retrieve follow-up questions with GET /api/v1/questions?include=conditional_questions. The parent's relationships.conditional_questions.data references child resources in included (also type questions).

When to show a child

Each child's attributes.conditional identifies its parent, display order (position), and condition:

{
  "parent_question_id": "123",
  "position": 1,
  "conditions": [{ "operator": "equals", "value": "true" }]
}

Show this child when parent 123 is answered Yes. conditional: null means the question is not a conditional child. Evaluate conditions[0] against the parent's answer.

Parent typeOperatorsValue to compare
booleanequals, not_equals"true" / "false"
short_text, long_textequals, not_equals, contains, not_containsCase-sensitive text
urlequals, not_equalsCase-sensitive URL text
multiple_choiceequals, not_equalsOption text, not ID; membership for multi-select
number, dateequals, not_equals, greater_than, less_thanParsed number or date
document, multi_documentequals, not_equals"true" means a file is attached

Values are returned as stored. Dates may use non-ISO formats; translated options use canonical English text. date_range has no supported conditions.

Submit answers

Use Create Answer with the child's own ID in data.relationships.question.data.id, the appropriate answer field, and the application's answerable relationship. Do not send conditional metadata.

For example, after answering Yes to parent 123, submit a text answer to child 124 for application 456 (example IDs):

POST /api/v1/answers
{
  "data": {
    "type": "answers",
    "attributes": {
      "text_answer": "I require visa sponsorship."
    },
    "relationships": {
      "question": { "data": { "type": "questions", "id": "124" } },
      "answerable": { "data": { "type": "applications", "id": "456" } }
    }
  }
}

Your integration controls visibility and collects required answers for visible children. The API does not enforce these conditional rules: omit answers to hidden children.

Query Params
include
array of strings, unique
fields[questions]
array of objects, unique
fields[scorecard_sections]
array of objects, unique
boolean

Filter records based on whether they're marked as banked

date-time

Filter records with created_at greater than this value

date-time

Filter records with created_at less than this value

date-time

Filter records with updated_at greater than this value

date-time

Filter records with updated_at less than this value

string

Filter records by Structured section id

filter[questionable_id]
object

Filter records by Questionable id

sort
array of strings, unique

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

integer
Defaults to 1

The page number of records to return

integer
0 to 1000
Defaults to 100

The number of records to return

string
enum

Include the total number of matched records within the meta key of the response object.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json