List modules

Returns a cursor-paginated list of modules. Each item includes the latest version summary (no nested exams, files, or connections). Use GET /modules/{id} for full version detail. Scoped to your integration’s institution via Basic Auth credentials.

GET/modules

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Query parameters

cursorstring

limitinteger

default: 10

searchstring

showArchivedboolean

Responses

200

List of modules

dataModule[]required

Show properties

Array of Module

idstringrequired

namestringrequired

institutionIdstringrequired

codestring | null

isArchivedboolean | null

nameTranslationsobject | null

versionsModuleVersion[]

Latest version only (at most one item). Summary fields; no nested exams or files.

Show properties

Array of ModuleVersion

idstringrequired

versionstringrequired

namestringrequired

descriptionstring | nullrequired

May be an empty string when not set.

iconstring | nullrequired

iconTypestring | nullrequired

bannerstring | nullrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

requiredAttendancePercentageintegerrequired

ectsPointsintegerrequired

courseModuleIdstringrequired

statusstringrequired

Allowed:DRAFTACTIVEARCHIVED

timePlanIdstring | nullrequired

isDefaultbooleanrequired

earlyAssessmentEnabledbooleanrequired

isCurrentlyElectablebooleanrequired

capacityinteger | nullrequired

colorinteger | nullrequired

courseChatFileAttachmentsDefaultbooleanrequired

courseChatReadOnlyDefaultbooleanrequired

courseFeatureDefaultsobject | nullrequired

moduleNamestring | nullrequired

attemptRulesobject | nullrequired

paginationCursorPaginationrequired

Show properties

next_cursorstring | nullrequired

has_morebooleanrequired

limitintegerrequired

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

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

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

cursorquerylimitquerysearchqueryshowArchivedquery

Request

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

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

import requests

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

Response

{
  "data": [
    {
      "id": "cmqevazrw05p34pi9wv9w3mks",
      "name": "Business Administration",
      "institutionId": "inst_123",
      "code": "BA-101",
      "isArchived": false,
      "nameTranslations": null,
      "versions": [
        {
          "id": "cmqevazu005pb4pi9zp2zthd1",
          "version": "2.0.0",
          "name": "Business Administration Basics",
          "description": "",
          "icon": null,
          "iconType": "emoji",
          "banner": null,
          "createdAt": "2026-06-15T07:04:18.408Z",
          "updatedAt": "2026-06-15T07:04:18.408Z",
          "requiredAttendancePercentage": 80,
          "ectsPoints": 5,
          "courseModuleId": "cmqevazrw05p34pi9wv9w3mks",
          "status": "ACTIVE",
          "timePlanId": "cmqevazr905p14pi9st41ex1w",
          "isDefault": false,
          "earlyAssessmentEnabled": false,
          "isCurrentlyElectable": true,
          "capacity": null,
          "color": null,
          "courseChatFileAttachmentsDefault": true,
          "courseChatReadOnlyDefault": false,
          "courseFeatureDefaults": null,
          "moduleName": null,
          "attemptRules": null
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "limit": 10
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00: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"
    }
  ]
}