Get Assessment Question Section

get

https://{hostname}/api/assessment/v2/assessments/{assessmentId}/sections/navigate

Use this API to retrieve a section of assessment questions. The response includes the questions within the requested section, available response options, and any previously submitted responses. Questions hidden by navigation rules are not returned.

🗒
Things to Know

By default, only required unanswered questions are returned.

To retrieve all questions in the section, specify filter=ALL_QUESTIONS as a query parameter.

To retrieve the assessment's welcome or introduction content instead of assessment questions, specify direction=WELCOME as a query parameter. If no welcome content is configured, specify direction=FIRST.

Each question includes available response options and any previously submitted responses. Response option identifiers can be used when submitting responses through the Submit Responses API.

Path Params

assessmentId

uuid

required

UUID of the assessment to fetch a section from

Query Params

direction

string

enum

required

Which section to fetch relative to sectionId. WELCOME and FIRST both ignore sectionId; CURRENT/NEXT/PREVIOUS all require it. Case-insensitive.

Allowed:

sectionId

uuid

Section to navigate relative to. Required for CURRENT/NEXT/PREVIOUS; ignored for WELCOME/FIRST. Comes from a previous call to this endpoint.

filter

string

enum

Which questions in the section to include. Case-insensitive.

Allowed:

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*

200OK

429Too Many Requests. For more information, see API Rate Limits.