Events API: Events

Retrieve one specific event

get

Authorizations

BearerstringRequired

Path parameters

eventstring · uuidRequired

Responses

404

Not Found

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/events/{event}

GET /v2/e01/api/events/{event} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Check for the existence of one specific event

head

Authorizations

BearerstringRequired

Path parameters

eventstring · uuidRequired

Responses

200

404

Not Found

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/events/{event}

HEAD /v2/e01/api/events/{event} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collect the list of events that match specific criteria

post

Authorizations

BearerstringRequired

Body

DistributionExpectedSincestring · date-time · nullableOptional

DistributionExpectedBeforestring · date-time · nullableOptional

DistributionOrderedSincestring · date-time · nullableOptional

DistributionOrderedBeforestring · date-time · nullableOptional

DistributionShippedSincestring · date-time · nullableOptional

DistributionShippedBeforestring · date-time · nullableOptional

DistributionTrackedSincestring · date-time · nullableOptional

DistributionTrackedBeforestring · date-time · nullableOptional

EventScheduledEndSincestring · date-time · nullableOptional

EventScheduledEndBeforestring · date-time · nullableOptional

EventScheduledStartSincestring · date-time · nullableOptional

EventScheduledStartBeforestring · date-time · nullableOptional

ExamMaterialReturnShipmentReceivedSincestring · date-time · nullableOptional

ExamMaterialReturnShipmentReceivedBeforestring · date-time · nullableOptional

ExamStartedSincestring · date-time · nullableOptional

ExamStartedBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

RegistrationDeadlineSincestring · date-time · nullableOptional

RegistrationDeadlineBeforestring · date-time · nullableOptional

RegistrationLockedSincestring · date-time · nullableOptional

RegistrationLockedBeforestring · date-time · nullableOptional

RegistrationStartSincestring · date-time · nullableOptional

RegistrationStartBeforestring · date-time · nullableOptional

Responses

200

post

/api/events/collect

POST /v2/e01/api/events/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1307

{
  "DistributionExpectedSince": "2026-05-08T21:39:35.742Z",
  "DistributionExpectedBefore": "2026-05-08T21:39:35.742Z",
  "DistributionOrderedSince": "2026-05-08T21:39:35.742Z",
  "DistributionOrderedBefore": "2026-05-08T21:39:35.742Z",
  "DistributionShippedSince": "2026-05-08T21:39:35.742Z",
  "DistributionShippedBefore": "2026-05-08T21:39:35.742Z",
  "DistributionTrackedSince": "2026-05-08T21:39:35.742Z",
  "DistributionTrackedBefore": "2026-05-08T21:39:35.742Z",
  "EventScheduledEndSince": "2026-05-08T21:39:35.742Z",
  "EventScheduledEndBefore": "2026-05-08T21:39:35.742Z",
  "EventScheduledStartSince": "2026-05-08T21:39:35.742Z",
  "EventScheduledStartBefore": "2026-05-08T21:39:35.742Z",
  "ExamMaterialReturnShipmentReceivedSince": "2026-05-08T21:39:35.742Z",
  "ExamMaterialReturnShipmentReceivedBefore": "2026-05-08T21:39:35.742Z",
  "ExamStartedSince": "2026-05-08T21:39:35.742Z",
  "ExamStartedBefore": "2026-05-08T21:39:35.742Z",
  "LastChangeTimeSince": "2026-05-08T21:39:35.742Z",
  "LastChangeTimeBefore": "2026-05-08T21:39:35.742Z",
  "RegistrationDeadlineSince": "2026-05-08T21:39:35.742Z",
  "RegistrationDeadlineBefore": "2026-05-08T21:39:35.742Z",
  "RegistrationLockedSince": "2026-05-08T21:39:35.742Z",
  "RegistrationLockedBefore": "2026-05-08T21:39:35.742Z",
  "RegistrationStartSince": "2026-05-08T21:39:35.742Z",
  "RegistrationStartBefore": "2026-05-08T21:39:35.742Z"
}

200

[
  {
    "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
    "EventId": "123e4567-e89b-12d3-a456-426614174000",
    "LearnerRegistrationGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "MandatorySurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
    "VenueCoordinatorId": "123e4567-e89b-12d3-a456-426614174000",
    "VenueLocationId": "123e4567-e89b-12d3-a456-426614174000",
    "VenueOfficeId": "123e4567-e89b-12d3-a456-426614174000",
    "AllowMultipleRegistrations": true,
    "AllowRegistrationWithLink": true,
    "BillingCodeEnabled": true,
    "IntegrationWithholdDistribution": true,
    "IntegrationWithholdGrades": true,
    "PersonCodeIsRequired": true,
    "WaitlistEnabled": true,
    "AppointmentType": "text",
    "Content": "text",
    "DistributionCode": "text",
    "DistributionErrors": "text",
    "DistributionProcess": "text",
    "DistributionStatus": "text",
    "DurationUnit": "text",
    "EventBillingType": "text",
    "EventCalendarColor": "text",
    "EventClassCode": "text",
    "EventDescription": "text",
    "EventFormat": "text",
    "EventPublicationStatus": "text",
    "EventRequisitionStatus": "text",
    "EventSchedulingStatus": "text",
    "EventSource": "text",
    "EventSummary": "text",
    "EventTitle": "text",
    "EventType": "text",
    "ExamMaterialReturnShipmentCode": "text",
    "ExamMaterialReturnShipmentCondition": "text",
    "ExamType": "text",
    "LastChangeType": "text",
    "LastChangeUser": "text",
    "PublicationErrors": "text",
    "RegistrationFields": "text",
    "VenueRoom": "text",
    "CapacityMaximum": 1,
    "CapacityMinimum": 1,
    "DurationQuantity": 1,
    "EventNumber": 1,
    "ExamDurationInMinutes": 1,
    "InvigilatorMinimum": 1,
    "CreditHours": 1,
    "DistributionExpected": "2026-05-08T21:39:35.742Z",
    "DistributionOrdered": "2026-05-08T21:39:35.742Z",
    "DistributionShipped": "2026-05-08T21:39:35.742Z",
    "DistributionTracked": "2026-05-08T21:39:35.742Z",
    "EventScheduledEnd": "2026-05-08T21:39:35.742Z",
    "EventScheduledStart": "2026-05-08T21:39:35.742Z",
    "ExamMaterialReturnShipmentReceived": "2026-05-08T21:39:35.742Z",
    "ExamStarted": "2026-05-08T21:39:35.742Z",
    "LastChangeTime": "2026-05-08T21:39:35.742Z",
    "RegistrationDeadline": "2026-05-08T21:39:35.742Z",
    "RegistrationLocked": "2026-05-08T21:39:35.742Z",
    "RegistrationStart": "2026-05-08T21:39:35.742Z"
  }
]

Count the events that match specific criteria