v1

latestOpenAPI 3.0.12026-07-2466310316.3 KB

Questions

List Questions

get/api/v1/questions

Query parameters

includestring[]

Question relationships available for inclusion

Include related resources

fields[questions]QuestionsReadableAttribute[]

Question readable attributes list

Include only specified fields of Question in response

fields[scorecard_sections]ScorecardSectionsReadableAttribute[]

Scorecard Section readable attributes list

Include only specified fields of Scorecard Section in response

filter[banked]boolean

Banked filter

Filter records based on whether they're marked as banked

filter[created_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at greater than this value

filter[created_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with created_at less than this value

filter[updated_at][gt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at greater than this value

filter[updated_at][lt]string date-time

String representation of datetime

Example:2019-01-01T00:00:00+00:00

Filter records with updated_at less than this value

filter[structured_section_id]string

Structured section id filter

Filter records by Structured section id

filter[questionable_id]object

Questionable id filter

Filter records by Questionable id

sortstring[]

Question sortable attributes

Sort records according to one or more criteria

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

page[number]integer

Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'

Example:count

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

Response

OK: Questions collection