--- title: "Get event summaries" method: POST path: "/v2/events/summaries" tags: ["Events"] --- # Get event summaries `POST /v2/events/summaries` View summaries of specific events. This endpoint retrieves a list of traveler event summaries based on specified `userId`, `companyId`, and `tripIds`. ## Request body - GetEventSummariesRequest — Request to get Event summaries - `userId` UserId — User identifier - `id` string, uuid, required - `companyId` CompanyId — Company ID - `id` string, uuid, required - `tripIds` string[] — List of Spotnana trip IDs ## Response `200` OK - GetEventSummariesResponse — Response to return Event summaries - `tripEventSummaries` TripEventSummary[] — List of Event summaries for trips - `tripId` string — Spotnana trip ID - `travelerEventSummary` TravelerEventSummary — Event summary for a traveler - `id` string, required — Event ID - `type` 'GENERIC' | 'PROGRAM' | 'PROGRAM_SESSION' | 'PROGRAM_TRIP' — Type of an event - `name` string — Name of the event - `description` string — Description of the event - `startDateTime` DateTimeLocal — Local date and time in ISO 8601 format. - `iso8601` string, required - `endDateTime` DateTimeLocal — Local date and time in ISO 8601 format. - `iso8601` string, required - `location` EventLocation — Location for an event - `address` PostalAddress — Postal Address Details - `addressLines` string[], required — Address lines - `administrativeArea` string — Code of administrative area. For example: DL for Delhi, India. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. - `administrativeAreaName` string — Name of administrative area. This is full name corresponding to administrativeArea. Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo. - `description` string — Address description - `isDefault` boolean — Whether this address is default address in case multiple addresses are specified. - `languageCode` string — BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. Examples: "zh-Hant", "ja", "ja-Latn", "en". - `locality` string — Generally refers to the city/town portion of the address. - `locationCode` string — IATA 3-letter location code. See https://www.iata.org/en/services/codes. - `organization` string — The name of the organization at the address. - `postalCode` string — Postal code of the address. This is a required field when setting for a user/legal entity/company etc. - `continentCode` string — 2 letter continent code of the continent this address falls in. - `recipients` string[] — The recipient at the address. - `regionCode` string, required — Region code of the country/region of the address. - `regionName` string — Region name of the country/region of the address. - `revision` integer - `sortingCode` string — Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). - `sublocality` string — Sublocality of the address. This can be neighborhoods, boroughs, districts. - `timezone` string — Time zone of the address. - `coordinates` Latlng — Latitude and Longitude for a Location - `latitude` number, double, required — Latitude of the Location - `longitude` number, double, required — Longitude of the Location - `coordinates` Latlng — Latitude and Longitude for a Location - `latitude` number, double, required — Latitude of the Location - `longitude` number, double, required — Longitude of the Location - `contacts` UserId[] — Event contacts for the traveler - `id` string, uuid, required - `documents` Document[] — List of documents associated with this event for the traveler - `url` string, required — S3 location of the document. - `documentId` string, uuid, required — Unique identifier of the document. - `documentMetadata` DocumentMetadata, required — Metadata related to document. - `documentType` 'BOARDING_PASS' | 'CONFIRMATION' | 'INVOICE' | 'VISA' | 'MISCELLANEOUS' | 'OTHERS' | 'TASK_PROCESSOR' | 'EVENT_COVER_IMAGE' | 'LOGO_IMAGE', required — Document type. - `entityType` 'PNR' | 'COMPANY' | 'AIR_ITINERARY' | 'EVENT' | 'LOCATION_IMAGE' | 'AIR_COMMISSION_CONTRACT', required — Entity type against which the document is to uploaded. - `entityId` string, required — Entity Id for the given entity type. - `entityMetadata` union, required — Metadata for associated entity of document. - object - … - object - … - `name` string, required — Document name. - `bookingGuidelines` EventBookingGuideline[] — Booking details allowed for the event for the traveler - union — Booking details allowed for the event - object — Wrapper for AirBookingGuideline - `airBookingGuideLine` AirBookingGuideline — Air related guidelines - … - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - object — Wrapper for HotelBookingGuideline - `hotelBookingGuideLine` HotelBookingGuideline — Hotel related guidelines - … - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - object — Wrapper for CarBookingGuideline - `carBookingGuideLine` CarBookingGuideline — Car related guidelines - … - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - object — Wrapper for RailBookingGuideline - `railBookingGuideLine` RailBookingGuideline — Rail related guidelines - … - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - `allowedBookingTypes` EventAllowedBookingType[] — Allowed booking types for the event for the traveler - `eventUserRsvp` EventUserRsvp — User rsvp for the event - `userId` UserId — User identifier - `id` string, uuid, required - `eventRsvpState` 'ADDED' | 'INVITED' | 'INVITE_ACCEPTED' | 'INVITE_DECLINED' | 'REMOVED' — Allowed event rsvp states for a user - `eventRsvpResponse` EventRsvpResponse — Event rsvp response - `air` AirRsvpResponse — Air rsvp response - `notNeeded` boolean — Whether air booking is needed by the traveler or not - `hotel` HotelRsvpResponse — Hotel rsvp response - `notNeeded` boolean — Whether hotel booking is needed by the traveler or not - `car` CarRsvpResponse — Car rsvp response - `notNeeded` boolean — Whether car booking is needed by the traveler or not - `rail` RailRsvpResponse — Rail rsvp response - `notNeeded` boolean — Whether rail booking is needed by the traveler or not - `invitedAt` DateTimeOffset — ISO8601 UTC Date Time - `iso8601` string, required - `airBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT' — Booking status of the travel. - `railBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT' — Booking status of the travel. - `carBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT' — Booking status of the travel. - `hotelBookingStatus` 'BOOKED' | 'NOT_BOOKED' | 'OPTED_OUT' — Booking status of the travel. - `contactInfoList` EventUserInfo[] — Event contacts for the traveler - `userId` UserId, required — User identifier - `id` string, uuid, required - `email` string — Business email of the user - `name` Name, required — Full name containing first, middle, last (family) names, and suffix. - `family1` string, required — Last (family) name. - `family2` string - `given` string, required — First (given) name. - `middle` string — Middle name. - `suffix` 'NAME_SUFFIX_UNKNOWN' | 'SR' | 'JR' | 'MD' | 'PHD' | 'II' | 'III' | 'IV' | 'DO' | 'ATTY' | 'V' | 'VI' | 'ESQ' | 'DC' | 'DDS' | 'VM' | 'JD' | 'SECOND' | 'THIRD' — Suffix for name - `preferred` string — Informal preferred name added by traveler. This is not used on any PNR or tickets - `companyId` EntityId — Identifier of an object - `id` string, uuid, required - `runningStatus` 'IN_PROGRESS' | 'UPCOMING' | 'COMPLETED' — Running status of an event - `status` 'DRAFT' | 'PUBLISH' | 'CANCELLED' — Status of an event - `isRemovedParticipant` boolean — Whether the traveler is part of the event. - `inviteEmailConfig` InviteEmailConfig — Configuration for event invite/reminder emails - `emailExcludeCoordinatorInfo` boolean — Whether to exclude coordinator information in emails sent to travelers. - `parentEventId` string — Optional parent event's id. - `bookingStyle` 'SELF_SERVE' | 'AGENT_MANAGED' — The booking style for the event's participants. - `allowTravelersToRsvp` 'ALLOWED' | 'NOT_ALLOWED' — Allow travelers to rsvp for the event ## Other responses - `400` — Bad request - `401` — Unauthorized - `403` — Forbidden --- [API](https://skmtc.net/spotnana/apis/event-api.md) · [All operations](https://skmtc.net/spotnana/apis/event-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/event-api/revisions/13f531f73066/schema)