View assessment questions. Requires assessments.read permission.
Query parameters
| Name |
Type |
Required |
Description |
assessmentId |
string (uuid) |
no |
Filter by assessment |
type |
string |
no |
Filter by question type One of: multiple_choice, true_false, free_text. |
fields[] |
string[] |
no |
Select which fields to include in the response. When omitted, all fields are returned. When provided, only the specified fields are included. (e.g., ?fields[]=id&fields[]=question) One of: assessmentId, canonicalId, createdAt, explanation, id, isCurrent, options, order, points, question, required, type, updatedAt, version. |
with[] |
string[] |
no |
Include related resources in the response. Pass multiple values as separate query parameters (e.g., ?with[]=createdBy&with[]=updatedBy). One of: createdBy, updatedBy, assessment. |
orderBy |
string |
no |
Field to order by One of: id, question, type, points, order, version, createdAt, updatedAt. |
order |
string |
no |
Specifies in what direction the results should be ordered (ASC/DESC) One of: asc, desc. |
count |
integer |
no |
Specifies the number of results to show per page of paginated results (1-500) |
Responses
| Status |
Description |
| 200 |
A paginated response of assessment questions |
Response 200 body
data object[] · required
links object · required
meta object · required
{
"data": [
{
"id": "01944f76-3f07-76fe-b4fe-f8e5b0db5abe",
"assessment": {
"id": "01944f76-3f07-76fe-b4fe-f8e5b0db5abe",
"title": "Safety Protocol Quiz"
},
"assessmentId": "01944f76-3f07-76fe-b4fe-f8e5b0db5abc",
"canonicalId": "01944f76-3f07-76fe-b4fe-f8e5b0db5abe",
"createdAt": "string",
"createdBy": {
"id": "019222d9-d87d-7724-bba6-ba91503ea311",
"firstName": "John",
"lastName": "Doe"
},
"explanation": "Always wear protective equipment when handling hazardous materials.",
"isCurrent": true,
"options": [
"Option A",
"Option B",
"Option C",
"Option D"
],
"order": 0,
"points": 1,
"question": "What is the correct procedure for handling hazardous materials?",
"required": true,
"type": "multiple_choice",
"updatedAt": "string",
"updatedBy": {
"id": "019222d9-d87d-7724-bba6-ba91503ea311",
"firstName": "John",
"lastName": "Doe"
},
"version": 1
}
],
"links": {
"first": "https://api.safesites.app/sites?page=1",
"last": "https://api.safesites.app/sites?page=10",
"prev": null,
"next": "https://api.safesites.app/sites?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 10,
"links": [
{
"url": "https://api.safesites.app/sites?page=2",
"label": "Next",
"active": true
}
],
"path": "https://api.safesites.app/sites",
"per_page": 100,
"to": 100,
"total": 1000,
"userId": "01930a9b-7b61-79a5-9ba2-78f0b4b2c196",
"requestId": "01930a9b-8d1f-766f-945c-ef6408134dbc"
}
}