Ctrlk
Shift iQ
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Events API: Events

Retrieve one specific event

get
Authorizations
BearerstringRequired
Path parameters
eventstring · uuidRequired
Responses
200

OK

AchievementIdstring · uuid · nullableOptional
EventIdstring · uuidOptional
LearnerRegistrationGroupIdstring · uuid · nullableOptional
MandatorySurveyFormIdstring · uuid · nullableOptional
VenueCoordinatorIdstring · uuid · nullableOptional
VenueLocationIdstring · uuid · nullableOptional
VenueOfficeIdstring · uuid · nullableOptional
AllowMultipleRegistrationsbooleanOptional
AllowRegistrationWithLinkboolean · nullableOptional
BillingCodeEnabledbooleanOptional
IntegrationWithholdDistributionbooleanOptional
IntegrationWithholdGradesbooleanOptional
PersonCodeIsRequiredbooleanOptional
WaitlistEnabledbooleanOptional
AppointmentTypestring · nullableOptional
Contentstring · nullableOptional
DistributionCodestring · nullableOptional
DistributionErrorsstring · nullableOptional
DistributionProcessstring · nullableOptional
DistributionStatusstring · nullableOptional
DurationUnitstring · nullableOptional
EventBillingTypestring · nullableOptional
EventCalendarColorstring · nullableOptional
EventClassCodestring · nullableOptional
EventDescriptionstring · nullableOptional
EventFormatstring · nullableOptional
EventPublicationStatusstring · nullableOptional
EventRequisitionStatusstring · nullableOptional
EventSchedulingStatusstring · nullableOptional
EventSourcestring · nullableOptional
EventSummarystring · nullableOptional
EventTitlestring · nullableOptional
EventTypestring · nullableOptional
ExamMaterialReturnShipmentCodestring · nullableOptional
ExamMaterialReturnShipmentConditionstring · nullableOptional
ExamTypestring · nullableOptional
LastChangeTypestring · nullableOptional
LastChangeUserstring · nullableOptional
PublicationErrorsstring · nullableOptional
RegistrationFieldsstring · nullableOptional
VenueRoomstring · nullableOptional
CapacityMaximuminteger · int32 · nullableOptional
CapacityMinimuminteger · int32 · nullableOptional
DurationQuantityinteger · int32 · nullableOptional
EventNumberinteger · int32Optional
ExamDurationInMinutesinteger · int32 · nullableOptional
InvigilatorMinimuminteger · int32 · nullableOptional
CreditHoursnumber · double · nullableOptional
DistributionExpectedstring · date-time · nullableOptional
DistributionOrderedstring · date-time · nullableOptional
DistributionShippedstring · date-time · nullableOptional
DistributionTrackedstring · date-time · nullableOptional
EventScheduledEndstring · date-time · nullableOptional
EventScheduledStartstring · date-timeOptional
ExamMaterialReturnShipmentReceivedstring · date-time · nullableOptional
ExamStartedstring · date-time · nullableOptional
LastChangeTimestring · date-time · nullableOptional
RegistrationDeadlinestring · date-time · nullableOptional
RegistrationLockedstring · date-time · nullableOptional
RegistrationStartstring · date-time · nullableOptional
get/api/events/{event}
GET /v2/e01/api/events/{event} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "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-01-01T00:00:00.000Z",
  "DistributionOrdered": "2026-01-01T00:00:00.000Z",
  "DistributionShipped": "2026-01-01T00:00:00.000Z",
  "DistributionTracked": "2026-01-01T00:00:00.000Z",
  "EventScheduledEnd": "2026-01-01T00:00:00.000Z",
  "EventScheduledStart": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceived": "2026-01-01T00:00:00.000Z",
  "ExamStarted": "2026-01-01T00:00:00.000Z",
  "LastChangeTime": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadline": "2026-01-01T00:00:00.000Z",
  "RegistrationLocked": "2026-01-01T00:00:00.000Z",
  "RegistrationStart": "2026-01-01T00:00:00.000Z"
}

Check for the existence of one specific event

head
Authorizations
BearerstringRequired
Path parameters
eventstring · uuidRequired
Responses
200

OK

No content
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

OK

AchievementIdstring · uuid · nullableOptional
EventIdstring · uuidOptional
LearnerRegistrationGroupIdstring · uuid · nullableOptional
MandatorySurveyFormIdstring · uuid · nullableOptional
VenueCoordinatorIdstring · uuid · nullableOptional
VenueLocationIdstring · uuid · nullableOptional
VenueOfficeIdstring · uuid · nullableOptional
AllowMultipleRegistrationsbooleanOptional
AllowRegistrationWithLinkboolean · nullableOptional
BillingCodeEnabledbooleanOptional
IntegrationWithholdDistributionbooleanOptional
IntegrationWithholdGradesbooleanOptional
PersonCodeIsRequiredbooleanOptional
WaitlistEnabledbooleanOptional
AppointmentTypestring · nullableOptional
Contentstring · nullableOptional
DistributionCodestring · nullableOptional
DistributionErrorsstring · nullableOptional
DistributionProcessstring · nullableOptional
DistributionStatusstring · nullableOptional
DurationUnitstring · nullableOptional
EventBillingTypestring · nullableOptional
EventCalendarColorstring · nullableOptional
EventClassCodestring · nullableOptional
EventDescriptionstring · nullableOptional
EventFormatstring · nullableOptional
EventPublicationStatusstring · nullableOptional
EventRequisitionStatusstring · nullableOptional
EventSchedulingStatusstring · nullableOptional
EventSourcestring · nullableOptional
EventSummarystring · nullableOptional
EventTitlestring · nullableOptional
EventTypestring · nullableOptional
ExamMaterialReturnShipmentCodestring · nullableOptional
ExamMaterialReturnShipmentConditionstring · nullableOptional
ExamTypestring · nullableOptional
LastChangeTypestring · nullableOptional
LastChangeUserstring · nullableOptional
PublicationErrorsstring · nullableOptional
RegistrationFieldsstring · nullableOptional
VenueRoomstring · nullableOptional
CapacityMaximuminteger · int32 · nullableOptional
CapacityMinimuminteger · int32 · nullableOptional
DurationQuantityinteger · int32 · nullableOptional
EventNumberinteger · int32Optional
ExamDurationInMinutesinteger · int32 · nullableOptional
InvigilatorMinimuminteger · int32 · nullableOptional
CreditHoursnumber · double · nullableOptional
DistributionExpectedstring · date-time · nullableOptional
DistributionOrderedstring · date-time · nullableOptional
DistributionShippedstring · date-time · nullableOptional
DistributionTrackedstring · date-time · nullableOptional
EventScheduledEndstring · date-time · nullableOptional
EventScheduledStartstring · date-timeOptional
ExamMaterialReturnShipmentReceivedstring · date-time · nullableOptional
ExamStartedstring · date-time · nullableOptional
LastChangeTimestring · date-time · nullableOptional
RegistrationDeadlinestring · date-time · nullableOptional
RegistrationLockedstring · date-time · nullableOptional
RegistrationStartstring · date-time · nullableOptional
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-01-01T00:00:00.000Z",
  "DistributionExpectedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedSince": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionShippedSince": "2026-01-01T00:00:00.000Z",
  "DistributionShippedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedSince": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartBefore": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedSince": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedBefore": "2026-01-01T00:00:00.000Z",
  "ExamStartedSince": "2026-01-01T00:00:00.000Z",
  "ExamStartedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineSince": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedSince": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationStartSince": "2026-01-01T00:00:00.000Z",
  "RegistrationStartBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

[
  {
    "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-01-01T00:00:00.000Z",
    "DistributionOrdered": "2026-01-01T00:00:00.000Z",
    "DistributionShipped": "2026-01-01T00:00:00.000Z",
    "DistributionTracked": "2026-01-01T00:00:00.000Z",
    "EventScheduledEnd": "2026-01-01T00:00:00.000Z",
    "EventScheduledStart": "2026-01-01T00:00:00.000Z",
    "ExamMaterialReturnShipmentReceived": "2026-01-01T00:00:00.000Z",
    "ExamStarted": "2026-01-01T00:00:00.000Z",
    "LastChangeTime": "2026-01-01T00:00:00.000Z",
    "RegistrationDeadline": "2026-01-01T00:00:00.000Z",
    "RegistrationLocked": "2026-01-01T00:00:00.000Z",
    "RegistrationStart": "2026-01-01T00:00:00.000Z"
  }
]

Count the 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

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post/api/events/count
POST /v2/e01/api/events/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1307

{
  "DistributionExpectedSince": "2026-01-01T00:00:00.000Z",
  "DistributionExpectedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedSince": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionShippedSince": "2026-01-01T00:00:00.000Z",
  "DistributionShippedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedSince": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartBefore": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedSince": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedBefore": "2026-01-01T00:00:00.000Z",
  "ExamStartedSince": "2026-01-01T00:00:00.000Z",
  "ExamStartedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineSince": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedSince": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationStartSince": "2026-01-01T00:00:00.000Z",
  "RegistrationStartBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

{
  "Count": 1,
  "Summary": "text"
}

Download 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

OK

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

{
  "DistributionExpectedSince": "2026-01-01T00:00:00.000Z",
  "DistributionExpectedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedSince": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionShippedSince": "2026-01-01T00:00:00.000Z",
  "DistributionShippedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedSince": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartBefore": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedSince": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedBefore": "2026-01-01T00:00:00.000Z",
  "ExamStartedSince": "2026-01-01T00:00:00.000Z",
  "ExamStartedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineSince": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedSince": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationStartSince": "2026-01-01T00:00:00.000Z",
  "RegistrationStartBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

No content

Search for 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

OK

EventIdstring · uuidOptional
post/api/events/search
POST /v2/e01/api/events/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1307

{
  "DistributionExpectedSince": "2026-01-01T00:00:00.000Z",
  "DistributionExpectedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedSince": "2026-01-01T00:00:00.000Z",
  "DistributionOrderedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionShippedSince": "2026-01-01T00:00:00.000Z",
  "DistributionShippedBefore": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedSince": "2026-01-01T00:00:00.000Z",
  "DistributionTrackedBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledEndBefore": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartSince": "2026-01-01T00:00:00.000Z",
  "EventScheduledStartBefore": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedSince": "2026-01-01T00:00:00.000Z",
  "ExamMaterialReturnShipmentReceivedBefore": "2026-01-01T00:00:00.000Z",
  "ExamStartedSince": "2026-01-01T00:00:00.000Z",
  "ExamStartedBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineSince": "2026-01-01T00:00:00.000Z",
  "RegistrationDeadlineBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedSince": "2026-01-01T00:00:00.000Z",
  "RegistrationLockedBefore": "2026-01-01T00:00:00.000Z",
  "RegistrationStartSince": "2026-01-01T00:00:00.000Z",
  "RegistrationStartBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

[
  {
    "EventId": "123e4567-e89b-12d3-a456-426614174000"
  }
]
PreviousDiagnostics API
NextEvents API: Registrations

Last updated

Was this helpful?