Contract 2.0.0

Aforo API: 53 operations of contract/openapi.yaml(OpenAPI 3.1), grouped by tag. Rules link to the business rules RN-01 to RN-15 indocs/spec.md; errors are problem+json fromcontract/problems.yaml.

auth

Registration, login, refresh token rotation and logout.

Operations tagged auth
MethodPathSummaryRulesAuth
POST/api/v1/auth/registerRegister a user (operationId register)—none
POST/api/v1/auth/loginLog in (operationId login)RATE-LIMITnone
POST/api/v1/auth/refreshRotate the refresh token (operationId refreshToken)—none
POST/api/v1/auth/logoutLog out (operationId logout)—bearer

me

The authenticated user.

Operations tagged me
MethodPathSummaryRulesAuth
GET/api/v1/meCurrent user (operationId getMe)—bearer
GET/api/v1/me/invitationsMy pending invitations (operationId listMyInvitations)RN-15bearer
POST/api/v1/me/invitations/{invitationId}/acceptAccept an invitation (operationId acceptInvitation)RN-15, RN-12bearer

orgs

Organizations (tenants) and their members.

Operations tagged orgs
MethodPathSummaryRulesAuth
GET/api/v1/orgsList my organizations (operationId listOrgs)—bearer
POST/api/v1/orgsCreate an organization (operationId createOrg)RN-12bearer
GET/api/v1/orgs/{orgId}Get an organization (operationId getOrg)RN-11bearer
GET/api/v1/orgs/{orgId}/membersList members (operationId listMembers)—bearer
GET/api/v1/orgs/{orgId}/members/{userId}Get a membership (operationId getMember)—bearer
PATCH/api/v1/orgs/{orgId}/members/{userId}Change a member's role (operationId updateMember)RN-12bearer
DELETE/api/v1/orgs/{orgId}/members/{userId}Remove a member (operationId removeMember)RN-12bearer

invitations

Uniform invitations to join an organization (RN-15).

Operations tagged invitations
MethodPathSummaryRulesAuth
POST/api/v1/orgs/{orgId}/membersInvite a member (operationId addMember)RN-15, RN-12bearer
GET/api/v1/orgs/{orgId}/invitationsList invitations (operationId listInvitations)RN-15bearer
DELETE/api/v1/orgs/{orgId}/invitations/{invitationId}Revoke an invitation (operationId revokeInvitation)RN-15, RN-12bearer

venues

Places where events happen, each with an IANA time zone.

Operations tagged venues
MethodPathSummaryRulesAuth
GET/api/v1/orgs/{orgId}/venuesList venues (operationId listVenues)—bearer
POST/api/v1/orgs/{orgId}/venuesCreate a venue (operationId createVenue)RN-12bearer
GET/api/v1/orgs/{orgId}/venues/{venueId}Get a venue (operationId getVenue)—bearer
PATCH/api/v1/orgs/{orgId}/venues/{venueId}Update a venue (operationId updateVenue)RN-12bearer

events

Time slots with a seat capacity and an optional waitlist.

Operations tagged events
MethodPathSummaryRulesAuth
GET/api/v1/orgs/{orgId}/eventsList events (operationId listEvents)—bearer
POST/api/v1/orgs/{orgId}/eventsCreate an event (operationId createEvent)RN-12bearer
GET/api/v1/orgs/{orgId}/events/{eventId}Get an event (operationId getEvent)—bearer
PATCH/api/v1/orgs/{orgId}/events/{eventId}Update an event (operationId updateEvent)RN-06, RN-09, RN-12bearer
POST/api/v1/orgs/{orgId}/events/{eventId}/publishPublish an event (operationId publishEvent)RN-01, RN-12bearer
POST/api/v1/orgs/{orgId}/events/{eventId}/cancelCancel an event (operationId cancelEvent)RN-10, RN-12bearer
GET/api/v1/orgs/{orgId}/events/{eventId}/availabilitySeat availability (operationId getAvailability)—bearer

bookings

Seat reservations, cancellations, check-in and attendee export.

Operations tagged bookings
MethodPathSummaryRulesAuth
GET/api/v1/orgs/{orgId}/events/{eventId}/bookingsList bookings of an event (operationId listEventBookings)—bearer
POST/api/v1/orgs/{orgId}/events/{eventId}/bookingsBook seats (operationId createBooking)RN-01, RN-02, RN-03, RN-04, RN-05, RN-12bearer
GET/api/v1/orgs/{orgId}/events/{eventId}/bookings.csvExport attendees as CSV (operationId exportAttendeesCsv)RN-13bearer
GET/api/v1/orgs/{orgId}/bookings/{bookingId}Get a booking (operationId getBooking)—bearer
POST/api/v1/orgs/{orgId}/bookings/{bookingId}/cancelCancel a booking (operationId cancelBooking)RN-06, RN-07, RN-12bearer
POST/api/v1/orgs/{orgId}/bookings/{bookingId}/check-inCheck in a booking (operationId checkInBooking)RN-08, RN-12bearer
GET/api/v1/orgs/{orgId}/me/bookingsMy bookings (operationId listMyBookings)—bearer

calendar

Signed, revocable iCalendar feed per organization.

Operations tagged calendar
MethodPathSummaryRulesAuth
POST/api/v1/orgs/{orgId}/calendar-tokensCreate a calendar feed token (operationId createCalendarToken)RN-13, RN-12bearer
DELETE/api/v1/orgs/{orgId}/calendar-tokens/{tokenId}Revoke a calendar feed token (operationId revokeCalendarToken)RN-13, RN-12bearer
GET/api/v1/orgs/{orgId}/calendar.icsiCalendar feed (operationId getCalendarFeed)RN-13none

webhooks

Signed outbound notifications with delivery log.

Operations tagged webhooks
MethodPathSummaryRulesAuth
GET/api/v1/orgs/{orgId}/webhooksList webhook subscriptions (operationId listWebhooks)—bearer
POST/api/v1/orgs/{orgId}/webhooksCreate a webhook subscription (operationId createWebhook)RN-12bearer
GET/api/v1/orgs/{orgId}/webhooks/{webhookId}Get a webhook subscription (operationId getWebhook)—bearer
DELETE/api/v1/orgs/{orgId}/webhooks/{webhookId}Delete a webhook subscription (operationId deleteWebhook)RN-12bearer
GET/api/v1/orgs/{orgId}/webhooks/{webhookId}/deliveriesList deliveries (operationId listWebhookDeliveries)—bearer
POST/api/v1/orgs/{orgId}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliverRedeliver a delivery (operationId redeliverWebhook)WEBHOOK-DELIVERYbearer

audit

Append-only audit trail of every mutation.

Operations tagged audit
MethodPathSummaryRulesAuth
GET/api/v1/orgs/{orgId}/auditAudit trail (operationId listAudit)RN-12bearer

operational

Health, readiness, metrics, keys and the contract itself (outside `/api`).

Operations tagged operational
MethodPathSummaryRulesAuth
GET/healthzLiveness (operationId healthz)—none
GET/readyzReadiness (operationId readyz)—none
GET/metricsPrometheus metrics (operationId metrics)—none
GET/openapi.jsonThis contract (operationId getOpenApi)—none
GET/.well-known/jwks.jsonPublic signing keys (operationId getJwks)—none

test-mode

Only present when `AFORO_TEST_MODE=true`; otherwise they answer `404`.

Operations tagged test-mode
MethodPathSummaryRulesAuth
POST/__test__/resetReset to the seed (operationId testReset)—none
POST/__test__/usersBulk-create members for load scenarios (operationId testCreateUsers)—none
GET/__test__/fingerprintData fingerprint (operationId testFingerprint)—none