Skip to content

List Attendees ​

Returns a paginated list of attendances for a single course.

Required license

This endpoint requires the company's course license.

Request ​

GET /api/oauth/v2/resource/courses/{uuid}/attendees

HeaderValue
AuthorizationBearer {access_token}

URL parameters ​

ParameterTypeRequiredDescription
uuidstringYesUnique course ID

Query parameters ​

ParameterTypeRequiredDescription
statusstringNoFilters by status, combinable as a comma-separated list. Allowed values: active (not canceled), deleted (canceled). Default: all (all values). See Conventions.
offsetintegerNoStart position (default: 0)
limitintegerNoNumber of results (default: 50, max: 200)

Note: This endpoint always requires the scopes courses, users and customers.

Note: Without a status filter, this endpoint sorts by internal ID ascending, see Conventions.

Response ​

Success (200 OK) ​

json
{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "course": "c3d4e5f6-a7b8-9012-cdef-012345678901",
      "customer": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
      "bookingDate": "2026-03-01T10:00:00+01:00",
      "deleted": false,
      "deletedAt": null,
      "deletedBy": null,
      "stornoReason": null,
      "cancelableUntil": "2026-02-28T10:00:00+01:00",
      "customerNotice": null,
      "billStatus": "open"
    }
  ],
  "meta": {
    "total": 12,
    "offset": 0,
    "limit": 50
  }
}

Response fields ​

FieldTypeDescription
dataArrayList of attendances
data[].idstring (UUID) | nullUnique attendance ID. null until the backfill — a client expecting a string must handle null.
data[].coursestring (UUID) | nullCourse. Look up via Course Details
data[].customerstring (UUID) | nullCustomer. Look up via GET /customers/{uuid}
data[].bookingDatestring (ISO 8601) | nullBooking date
data[].deletedbooleantrue if the attendance is canceled — status is either registered or canceled
data[].deletedAtstring (ISO 8601) | nullCancellation timestamp, null if not canceled
data[].deletedBystring (UUID) | nullUser who canceled the attendance. Look up via GET /users/{uuid}
data[].stornoReasonstring | nullCancellation reason
data[].cancelableUntilstring (ISO 8601) | nullLast time for a free cancellation
data[].customerNoticestring | nullNote about the customer for this attendance
data[].billStatusstringBilling status: open, invoiced, ignore, unknown
meta.totalintegerTotal number of attendances (considering the status filter)
meta.offsetintegerCurrent start position
meta.limitintegerNumber of returned entries
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/courses/b2c3d4e5-f6a7-8901-bcde-f01234567890/attendees?status=all&offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors ​

StatusCodeDescription
400validation_errorstatus contains an invalid value
401invalid_clientInvalid or missing access token
403insufficient_scopeScope courses, users, or customers is missing
403insufficient_scopeCourse license not present
404not_foundCourse not found

Offisy GmbH