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-blocks

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Query parameters

cursorstring

limitinteger

min 1 · max 100 · default: 10

courseIdstring

Filter by course layer ID (the layerId field on the course, not the course entity id).

typestring

Filter by content block type

statusstring

Filter by status

includestring

Comma-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

200

Paginated list of content blocks. Each item always includes core fields; optional fields depend on the include query parameter (see examples).

dataContentBlockListItem[]required

Show properties

Array of ContentBlockListItem

idstringrequired

namestringrequired

descriptionstringrequired

typestringrequired

statusstringrequired

Allowed:PUBLISHEDCOMING_SOONDRAFTDISABLED

positioninteger | nullrequired

dueDatestring<date-time> | nullrequired

startDatestring<date-time> | nullrequired

specsobject

Optional. Present only when include=specs. See listContentBlocks response example includeSpecs.

expectedLearnTimeMinutesinteger | null

Optional. 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 properties

Array of ContentBlockCondition

idstringrequired

requiredBlockIdstringrequired

ID of the block whose progress is evaluated.

conditionTypestringrequired

SimpleDependency: required block must reach specific statuses. SurveyData: survey answers must match. WorkbenchData: workbench submission criteria. GradeData: grade pass/fail.

Allowed:SimpleDependencySurveyDataWorkbenchDataGradeData

conditionobjectrequired

Type-specific payload. SimpleDependency: { requiredStatus: string[] }. SurveyData: { questionId, optionIds }. WorkbenchData: { workbenchFileId, requiredStatus }. GradeData: { passed: boolean }.

paginationCursorPaginationrequired

Show properties

next_cursorstring | nullrequired

has_morebooleanrequired

limitintegerrequired

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

403

Forbidden

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

429

Too Many Requests

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

cursorquerylimitquerycourseIdqueryFilter by course layer ID (the layerId field on the course, not the course entity id).typequeryFilter by content block typestatusqueryFilter by statusincludequeryComma-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.

Request

curl -X GET 'https://fuxam.app/api/v4/content-blocks' \
  -H 'Authorization: Basic YOUR_CREDENTIALS'

const response = await fetch("https://fuxam.app/api/v4/content-blocks", {
  method: "GET",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS"
  }
});

import requests

response = requests.get(
    "https://fuxam.app/api/v4/content-blocks",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS"
    },
)

Response

{
  "data": [
    {
      "id": "cmqevay3u01654pi9ixfhwfik",
      "name": "Introduction",
      "description": "",
      "type": "Section",
      "status": "PUBLISHED",
      "position": 0,
      "dueDate": null,
      "startDate": null
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "limit": 20
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-23T12: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"
    }
  ]
}