Fuxam API v4

Fuxam API v4

Industry-standard public REST API with cursor pagination, RFC 7807 errors with machine-readable codes, sparse fieldsets, and idempotent creates.

Migration from v3

v3 remains available until the published Sunset date (see response headers). Bug-fixes only on v3 after v4 GA.

Authentication

All endpoints require Basic Auth using integration credentials:

Authorization: Basic <base64-encoded-clientId:clientSecret>

Interactive documentation (Try it)

Use the same origin as the app you are testing (so cookies and CORS match the deployment you mean).

1. Scalar (full reference) — open /api/v4/docs on your environment (for example https://fuxam.app/api/v4/docs or https://fuxam.appapi/v4/docs). The spec is loaded from /api/v4/openapi. Under Servers, select the base URL that points at that same environment (for local runs use https://fuxam.appapi/v4). Open Authentication → Basic Auth: set username to your integration client ID and password to your client secret (from Organization → API integrations in the dashboard).

2. Docs hub (by tag) — browse /en/docs or /de/docs for the same operations with the embedded playground; set the server URL and Basic Auth the same way.

Response Format

Success (single resource)

{
  "data": { ... },
  "meta": { "requestId": "req_...", "timestamp": "...", "version": "v4" }
}

Success (list)

{
  "data": [ ... ],
  "pagination": { "next_cursor": "...", "has_more": true, "limit": 10 },
  "meta": { "requestId": "req_...", "timestamp": "...", "version": "v4" }
}

Error (RFC 7807)

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_..."
}

HTTP status codes

422 vs 400: Use 422 for semantic validation (Zod schema failures, e.g. invalid limit, missing required fields, date format without timezone offset). Use 400 for transport-level issues (unparseable JSON, bad cursor token).

Query conventions:

• limit must be an integer between 1 and 100 (default 10). Out-of-range or non-numeric values return 422.
• Boolean filters (e.g. includeInactive, showArchived) must be the string "true" or "false".
• date-time request fields must include a timezone offset (Z or ±HH:MM).

Users

Core profile, membership, lifecycle, and institution demographics

• GETList users/users
• POSTCreate a user/users
• GETGet a user/users/{id}
• DELETERemove a user from the institution/users/{id}
• PATCHUpdate a user/users/{id}
• PATCHUpdate user activity/users/{id}/activity
• GETList user notes/users/{id}/notes
• POSTAdd a note/users/{id}/notes
• DELETEDelete a note/users/{id}/notes/{noteId}
• PATCHUpdate a note/users/{id}/notes/{noteId}

Users/Roles & access

Institution roles, scoped role grants, primary role, and access packages

• GETList institution roles/roles
• GETList user role assignments/users/{id}/roles
• POSTAssign a role to a user/users/{id}/roles
• DELETERevoke a role assignment/users/{id}/roles/{assignmentId}
• PUTSet primary organisation role/users/{id}/primary-role
• POSTAssign an access package to a user/users/{id}/access-packages
• DELETERevoke an access package from a user/users/{id}/access-packages

Users/Data fields

Custom data field values and collection requests

• POSTRequest missing user data fields/users/{id}/data-collection-requests
• GETGet user data fields/users/{id}/data-fields
• PATCHUpsert user data field values/users/{id}/data-fields

Users/Invites

Pending invites and resend

• GETList pending invites/invites
• POSTResend an invite email/invites/{id}/resend

Users/Contact details

Emails, phones, and addresses

• GETList user emails/users/{id}/emails
• POSTAdd an email/users/{id}/emails
• DELETEDelete an email/users/{id}/emails/{emailId}
• PATCHUpdate an email/users/{id}/emails/{emailId}
• GETList user phones/users/{id}/phones
• POSTAdd a phone/users/{id}/phones
• DELETEDelete a phone/users/{id}/phones/{phoneId}
• PATCHUpdate a phone/users/{id}/phones/{phoneId}
• GETList user addresses/users/{id}/addresses
• POSTAdd an address/users/{id}/addresses
• DELETEDelete an address/users/{id}/addresses/{addressId}
• PATCHUpdate an address/users/{id}/addresses/{addressId}

Room Management

Rooms, locations, amenities, and utilization statistics.

• GETList rooms/rooms
• POSTCreate a room/rooms
• GETGet a room/rooms/{id}
• DELETEDelete a room/rooms/{id}
• PATCHUpdate a room/rooms/{id}
• GETGet utilization data for a room/rooms/{id}/utilization
• GETList locations/locations
• POSTCreate a location/locations
• GETGet a location/locations/{id}
• DELETEDelete a location/locations/{id}
• PATCHUpdate a location/locations/{id}
• GETList amenities/amenities
• POSTCreate an amenity/amenities
• GETGet an amenity/amenities/{id}
• DELETEDelete an amenity/amenities/{id}
• PATCHUpdate an amenity/amenities/{id}

Campus Management/Organization terms

Institution-wide academic terms (semesters). Used by curriculum version term mappings and cohort scheduling. Distinct from curriculum version terms under /curricula/.../versions/.../terms.

• GETList organization terms/organization-terms
• POSTCreate an organization term/organization-terms
• GETGet an organization term/organization-terms/{id}
• DELETEDelete an organization term/organization-terms/{id}
• PATCHUpdate an organization term/organization-terms/{id}

Users/User groups

User groups and group memberships

• GETList user groups/users/user-groups
• POSTCreate a user group/users/user-groups
• GETGet a user group/users/user-groups/{id}
• DELETEDelete a user group/users/user-groups/{id}
• PATCHUpdate a user group/users/user-groups/{id}
• GETList members of a user group/users/user-groups/{id}/members
• POSTAdd members to a user group/users/user-groups/{id}/members
• DELETERemove a member from a user group/users/user-groups/{id}/members/{userId}
• GETList groups a user belongs to/users/{id}/groups

Campus Management/Modules

Course modules and their versions (create, read, update, archive). List responses include summary fields; use GET by ID for full detail.

• GETList modules/modules
• POSTCreate a module/modules
• GETGet a module/modules/{id}
• DELETEDelete a module/modules/{id}
• PATCHUpdate a module/modules/{id}
• PATCHArchive or unarchive a module/modules/{id}/archive
• GETList versions of a module/modules/{id}/versions
• POSTCreate a module version/modules/{id}/versions
• GETGet a module version/modules/{id}/versions/{versionId}
• DELETEDelete a module version/modules/{id}/versions/{versionId}
• PATCHUpdate a module version/modules/{id}/versions/{versionId}

Campus Management/Module groups

Groups of module versions. Optional moduleIds on create/update attach modules by resolving each module’s default version.

• GETList module groups/module-groups
• POSTCreate a module group/module-groups
• GETGet a module group/module-groups/{id}
• DELETEDelete a module group/module-groups/{id}
• PATCHUpdate a module group/module-groups/{id}

Campus Management/Curricula

Curricula and versions: curriculum CRUD, version management, study terms, module-to-term mappings, and elective pathways. Optional moduleIds on create/update attach modules to the default version.

• GETList curricula/curricula
• POSTCreate a curriculum/curricula
• GETGet a curriculum/curricula/{id}
• DELETEDelete a curriculum/curricula/{id}
• PATCHUpdate a curriculum/curricula/{id}
• PATCHArchive or unarchive a curriculum/curricula/{id}/archive
• GETList curricula versions/curricula/{id}/versions
• POSTCreate a curricula version/curricula/{id}/versions
• GETGet a curricula version/curricula/{id}/versions/{versionId}
• DELETEDelete a curricula version/curricula/{id}/versions/{versionId}
• PATCHUpdate a curricula version/curricula/{id}/versions/{versionId}
• GETList terms in a curricula version/curricula/{id}/versions/{versionId}/terms
• POSTCreate a term in a curricula version/curricula/{id}/versions/{versionId}/terms
• DELETEDelete a term from a curricula version/curricula/{id}/versions/{versionId}/terms/{termId}
• PATCHUpdate a term in a curricula version/curricula/{id}/versions/{versionId}/terms/{termId}
• GETList pathways in a curricula version/curricula/{id}/versions/{versionId}/pathways
• POSTCreate a pathway in a curricula version/curricula/{id}/versions/{versionId}/pathways
• DELETEDelete a pathway from a curricula version/curricula/{id}/versions/{versionId}/pathways/{pathwayId}
• PATCHUpdate a pathway in a curricula version/curricula/{id}/versions/{versionId}/pathways/{pathwayId}

Campus Management/Study programs

Study programs (Bachelor, Master, etc.) including versions, cohorts, cohort members, connected curricula, and responsible users.

• GETList study programs/study-programs
• POSTCreate a study program/study-programs
• GETGet a study program/study-programs/{id}
• DELETEDelete a study program/study-programs/{id}
• PATCHUpdate a study program/study-programs/{id}
• GETList study program versions/study-programs/{id}/versions
• POSTCreate a study program version/study-programs/{id}/versions
• GETGet a study program version/study-programs/{id}/versions/{versionId}
• DELETEDelete a study program version/study-programs/{id}/versions/{versionId}
• PATCHUpdate a study program version/study-programs/{id}/versions/{versionId}
• GETList cohorts of a study program/study-programs/{id}/cohorts
• POSTCreate a cohort for a study program/study-programs/{id}/cohorts
• GETGet a cohort/study-programs/{id}/cohorts/{cohortId}
• DELETEDelete a cohort/study-programs/{id}/cohorts/{cohortId}
• PATCHUpdate a cohort/study-programs/{id}/cohorts/{cohortId}
• GETList cohort members/study-programs/{id}/cohorts/{cohortId}/members
• POSTAdd members to a cohort/study-programs/{id}/cohorts/{cohortId}/members
• DELETERemove a member from a cohort/study-programs/{id}/cohorts/{cohortId}/members/{userId}

Campus Management/Continuing education

Continuing education programs (type=CONTINUING_EDUCATION) — same capabilities as study programs: CRUD, versions, cohorts, curriculum attachment, and cohort members.

• GETList continuing education programs/continuing-education
• POSTCreate a continuing education program/continuing-education
• GETGet a continuing education program/continuing-education/{id}
• DELETEDelete a continuing education program/continuing-education/{id}
• PATCHUpdate a continuing education program/continuing-education/{id}
• GETList continuing education program versions/continuing-education/{id}/versions
• POSTCreate a continuing education program version/continuing-education/{id}/versions
• GETGet a continuing education program version/continuing-education/{id}/versions/{versionId}
• DELETEDelete a continuing education program version/continuing-education/{id}/versions/{versionId}
• PATCHUpdate a continuing education program version/continuing-education/{id}/versions/{versionId}
• GETList cohorts of a continuing education program/continuing-education/{id}/cohorts
• POSTCreate a cohort for a continuing education program/continuing-education/{id}/cohorts
• GETGet a cohort/continuing-education/{id}/cohorts/{cohortId}
• DELETEDelete a cohort/continuing-education/{id}/cohorts/{cohortId}
• PATCHUpdate a cohort/continuing-education/{id}/cohorts/{cohortId}
• GETList cohort members/continuing-education/{id}/cohorts/{cohortId}/members
• POSTAdd members to a cohort/continuing-education/{id}/cohorts/{cohortId}/members
• DELETERemove a member from a cohort/continuing-education/{id}/cohorts/{cohortId}/members/{userId}

Courses

Course resources and completion certificates

• GETLook up course completion certificates/certificates
• GETList courses/courses
• POSTCreate a course/courses
• GETGet a course by ID/courses/{id}
• DELETEDelete a course/courses/{id}
• PATCHUpdate a course/courses/{id}
• POSTAdd tags to a course/courses/{id}/tags
• POSTEnroll users in a course/courses/{id}/users

Appointments

Appointments and scheduling. Course IDs: list/create bodies use layer IDs (layerId from GET /courses), not course entity id. Use course entity id only in /courses/{id}/appointments. Create: appointments are recorded under an institution admin/moderator as creator (not the integration itself). Online/hybrid: isOnline and isHybrid may be adjusted server-side from rooms, address, and onlineAddress. Not supported via API: recurring series creation, attendance, appointment-type listing.

• GETList appointments for a course/courses/{id}/appointments
• POSTCreate an appointment for a course/courses/{id}/appointments
• GETList appointments/appointments
• POSTCreate an appointment/appointments
• GETGet an appointment by ID/appointments/{id}
• DELETEDelete an appointment/appointments/{id}
• PATCHUpdate an appointment/appointments/{id}

Courses/Content blocks

Content blocks, conditions, and progress tracking

• GETList content blocks/content-blocks
• POSTCreate a content block/content-blocks
• POSTBulk create content blocks/content-blocks/bulk
• DELETEBulk delete content blocks/content-blocks/bulk
• PATCHBulk update content blocks/content-blocks/bulk
• GETGet a content block by ID/content-blocks/{id}
• DELETEDelete a content block/content-blocks/{id}
• PATCHUpdate a content block/content-blocks/{id}
• GETList conditions for a content block/content-blocks/{id}/conditions
• POSTCreate a condition for a content block/content-blocks/{id}/conditions
• DELETEDelete a condition/content-blocks/{id}/conditions/{conditionId}
• PATCHUpdate a condition/content-blocks/{id}/conditions/{conditionId}
• GETGet progress for a user on a content block/content-blocks/{id}/progress/{userId}
• PATCHUpdate progress for a user on a content block/content-blocks/{id}/progress/{userId}
• POSTReset progress for a user on a content block/content-blocks/{id}/progress/{userId}/reset
• GETList sections and content blocks in a course/courses/{id}/content-blocks
• PUTReorder content blocks in a course/courses/{id}/content-blocks/reorder

Courses/Workbenches

Workbench resources

• GETList workbenches/workbenches
• POSTCreate a workbench/workbenches
• GETGet a workbench by ID/workbenches/{id}

Courses/User progress

User progress across course content

• GETGet user progress across course content blocks/users/{id}/progress