Saltar al contenido
Docs
Español
EnglishDeutschSin traducirEspañolSin traducir
Esc
↑↓navegar↵abrir⌘Jvista previa

List appointments

Lists appointments in your institution, sorted by start time (dateTime ascending, then id). Filter by courseIds using layer IDs (comma-separated layerId values from GET /courses). startDate / endDate filter on appointment start time (dateTime), not end time (dateTime + duration). Datetime query params must include a timezone offset (Z or ±HH:MM).

GET/appointments
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Query parameters
cursorstring
limitinteger
min 1 · max 100 · default: 10
startDatestring<date-time>

Include appointments with dateTime at or after this instant (ISO 8601).

endDatestring<date-time>

Include appointments with dateTime at or before this instant (ISO 8601). Does not use end-of-slot time.

courseIdsstring

Comma-separated layer IDs (layerId from GET /courses), not course entity IDs.

Responses
200

Paginated list with full relations (participants, creator, groups, series).

dataAppointment[]required
Show properties
Array of Appointment
idstringrequired
titlestringrequired
notesstring
dateTimestring<date-time>required
durationintegerrequired

Duration in minutes

isOnlinebooleanrequired
isHybridbooleanrequired
onlineAddressstring
addressstring
locationstring | null
providerstring
roomIdstring | null

Deprecated — use appointmentRooms.

appointmentRoomsAppointmentRoomBooking[]
Show properties
Array of AppointmentRoomBooking
roomIdstring
setupIdstring | null
roomobject
setupobject | null
appointmentLayersAppointmentLayer[]
Show properties
Array of AppointmentLayer
layerIdstring
layerobject | null
Show properties
idstring
namestring
courseobject | null
Show properties
idstring

Course entity ID

codestring | null
namestring
organizerUsersAppointmentOrganizer[]
Show properties
Array of AppointmentOrganizer
organizerIdstringrequired
appointmentUsersAppointmentUserParticipant[]
Show properties
Array of AppointmentUserParticipant
userIdstring
userAppointmentSafeUser
Show properties
idstring
namestring
emailstring
firstNamestring | null
lastNamestring | null
imagestring | null
appointmentCreatorobject[]

Institution admin/moderator used as creator for API-created appointments.

Show properties
Array of object
userIdstring
userAppointmentSafeUser
Show properties
idstring
namestring
emailstring
firstNamestring | null
lastNamestring | null
imagestring | null
appointmentUserGroupsobject[]
Show properties
Array of object
userGroupIdstring
userGroupobject
appointmentTypeobject | null
seriesobject | 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
Authorization
Parameters
Request
curl -X GET 'https://fuxam.app/api/v4/appointments' \
  -H 'Authorization: Basic YOUR_CREDENTIALS'
Response
{
  "data": [
    {
      "id": "appt_def456",
      "title": "Introduction lecture",
      "notes": "First session of the semester",
      "dateTime": "2026-09-15T10:00:00.000Z",
      "duration": 90,
      "isOnline": false,
      "isHybrid": false,
      "onlineAddress": "",
      "address": "Building A, Room 101",
      "location": null,
      "provider": "fuxam",
      "roomId": null,
      "appointmentLayers": [
        {
          "layerId": "layer_abc123",
          "layer": {
            "id": "layer_abc123",
            "name": "CS101"
          },
          "course": {
            "id": "clx1234567890",
            "code": "CS101",
            "name": "Introduction to Computer Science"
          }
        }
      ],
      "appointmentRooms": [],
      "organizerUsers": [
        {
          "organizerId": "user_organizer1"
        }
      ],
      "appointmentUsers": [
        {
          "userId": "user_student1",
          "user": {
            "id": "user_student1",
            "name": "Jane Doe",
            "email": "jane@example.com"
          }
        }
      ],
      "appointmentCreator": [
        {
          "userId": "user_admin1",
          "user": {
            "id": "user_admin1",
            "name": "Admin User",
            "email": "admin@example.com"
          }
        }
      ],
      "appointmentUserGroups": [],
      "appointmentType": null,
      "series": null
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "limit": 10
  },
  "meta": {
    "requestId": "req_1782305464335_hqnbhdhoaer",
    "timestamp": "2026-06-24T12:51:04.381Z",
    "version": "v4"
  }
}