List content blocks
Lists content blocks. Use include=specs, conditions, or specs,conditions for expanded fields. Filter by courseId (layer ID). Scoped to your integration’s institution via Basic Auth credentials.
GET
/content-blocksQuery parameters
cursorstringlimitintegermin 1 · max 100 · default: 10
courseIdstringFilter by course layer ID (the layerId field on the course, not the course entity id).
typestringFilter by content block type
statusstringFilter by status
includestringComma-separated optional expansions. `specs` adds specs, expectedLearnTimeMinutes, and createdAt to each item. `conditions` adds the conditions array. Combine both: `specs,conditions`. Without this parameter, only core list fields are returned.
Responses
200Paginated list of content blocks. Each item always includes core fields; optional fields depend on the `include` query parameter (see examples).
dataContentBlockListItem[]requiredShow propertiesHide properties
Array of
ContentBlockListItemidstringrequirednamestringrequireddescriptionstringrequiredtypestringrequiredstatusstringrequiredAllowed:
PUBLISHEDCOMING_SOONDRAFTDISABLEDpositioninteger | nullrequireddueDatestring<date-time> | nullrequiredstartDatestring<date-time> | nullrequiredspecsobjectOptional. Present only when `include=specs`. See listContentBlocks response example `includeSpecs`.
expectedLearnTimeMinutesinteger | nullOptional. Present only when `include=specs`. See listContentBlocks response example `includeSpecs`.
createdAtstring<date-time>Optional. Present only when `include=specs`. See listContentBlocks response example `includeSpecs`.
conditionsContentBlockCondition[]Optional. Present only when `include=conditions`. See listContentBlocks response example `includeConditions`.
Show propertiesHide properties
Array of
ContentBlockConditionidstringrequiredrequiredBlockIdstringrequiredID of the block whose progress is evaluated.
conditionTypestringrequiredSimpleDependency: required block must reach specific statuses. SurveyData: survey answers must match. WorkbenchData: workbench submission criteria. GradeData: grade pass/fail.
Allowed:
SimpleDependencySurveyDataWorkbenchDataGradeDataconditionobjectrequiredType-specific payload. SimpleDependency: `{ requiredStatus: string[] }`. SurveyData: `{ questionId, optionIds }`. WorkbenchData: `{ workbenchFileId, requiredStatus }`. GradeData: `{ passed: boolean }`.
paginationCursorPaginationrequiredShow propertiesHide properties
next_cursorstring | nullrequiredhas_morebooleanrequiredlimitintegerrequiredmetaResponseMetarequiredShow propertiesHide properties
requestIdstringrequiredtimestampstring<date-time>requiredversionstringrequiredAllowed:
v4400Bad Request
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring401Unauthorized
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring403Forbidden
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring429Too Many Requests
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestring500Internal Server Error
typestringrequiredAllowed:
errorcodestringrequiredAllowed:
bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_errortitlestringrequiredstatusintegerrequireddetailstringrequiredinstancestringerrorsobject[]Show propertiesHide properties
Array of
objectfieldstringmessagestringRequest
curl -X GET "https://fuxam.app/api/v4/content-blocks"const response = await fetch("https://fuxam.app/api/v4/content-blocks", {
method: "GET"
});import requests
response = requests.get(
"https://fuxam.app/api/v4/content-blocks",
)Response
{
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "string",
"status": "PUBLISHED",
"position": 0,
"dueDate": "2024-01-01T00:00:00Z",
"startDate": "2024-01-01T00:00:00Z",
"specs": {},
"expectedLearnTimeMinutes": 0,
"createdAt": "2024-01-01T00:00:00Z",
"conditions": [
{
"id": "string",
"requiredBlockId": "string",
"conditionType": "SimpleDependency",
"condition": {}
}
]
}
],
"pagination": {
"next_cursor": "string",
"has_more": true,
"limit": 0
},
"meta": {
"requestId": "req_1234567890_abc",
"timestamp": "2026-06-02T07:00:00.000Z",
"version": "v4"
}
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}{
"type": "error",
"code": "resource_not_found",
"title": "Not Found",
"status": 404,
"detail": "Course not found",
"instance": "req_1234567890_abc",
"errors": [
{
"field": "string",
"message": "string"
}
]
}