List courses

Returns courses in your institution. Each course includes id (entity ID) and layerId (used for appointments and content-block filters). Scoped to your integration’s institution via Basic Auth credentials.

GET/courses

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Query parameters

cursorstring

Cursor for pagination

limitinteger

Number of results per page (max 100)

min 1 · max 100 · default: 10

codestring

Filter by course code (exact match)

searchstring

Search by course name

statusstring

Filter by course status

Allowed:ACTIVEARCHIVED

tagIdsstring

Comma-separated list of tag IDs

isDatabaseboolean

Filter by database flag

Responses

200

Paginated list of courses

dataCourse[]required

Show properties

Array of Course

idstringrequired

codestring | nullrequired

namestringrequired

descriptionstring | null

iconstringrequired

iconTypestringrequired

Allowed:imageemoji

colorintegerrequired

min 0 · max 23

bannerImagestring | null

capacityinteger | null

statusstringrequired

Allowed:ACTIVEARCHIVED

isDatabasebooleanrequired

layerIdstringrequired

institutionIdstringrequired

tagsCourseTag[]required

Show properties

Array of CourseTag

idstringrequired

namestringrequired

colorstring | null

iconstring | null

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

cursorqueryCursor for paginationlimitqueryNumber of results per page (max 100)codequeryFilter by course code (exact match)searchquerySearch by course namestatusqueryFilter by course statustagIdsqueryComma-separated list of tag IDsisDatabasequeryFilter by database flag

Request

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

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

import requests

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

Response

{
  "data": [
    {
      "id": "cmh1cg59i002914ia01lve3i5",
      "code": "CS101",
      "name": "Introduction to Computer Science",
      "description": "An introductory course to computer science fundamentals",
      "icon": "/illustrations/course-icon-library/book-worm.webp",
      "iconType": "image",
      "color": 5,
      "bannerImage": "https://example.com/banner.jpg",
      "capacity": 50,
      "status": "ACTIVE",
      "isDatabase": false,
      "layerId": "layer_abc123",
      "institutionId": "inst_xyz789",
      "tags": [
        {
          "id": "tag_abc123",
          "name": "Mathematics",
          "color": "#FF5733",
          "icon": "🔢"
        }
      ]
    }
  ],
  "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"
    }
  ]
}