Krugo API API Reference
Microservices documentation for Krugo App.
API Endpoint
https://9b3nb73b8b.execute-api.us-west-2.amazonaws.com/devSchemes: https
Version: 0.0.1
appdata
getAppDataStartKeys
Gets a list of appData start keys to enable async data retrieval.
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"startKey": "string",
"sortKey": "string",
"startKeyName": "string",
"sortKeyName": "string",
"table": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getCurrentCacheKeys
Gets the most up to date cache keys.
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"lastUpdated": "number",
"secondaryKey": "string",
"primaryKey": "string",
"objectType": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getall
Gets all instances of an object.
undefined
Request Content-Types: application/json
Request Example
{
"startKey": "string",
"sortKey": "string",
"startKeyName": "string",
"sortKeyName": "string",
"table": "string",
"baseTableName": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
"array"
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
syncAppData
Gets all updated appData that the client is missing.
undefined
Request Content-Types: application/json
Request Example
{
"secondaryKey": "string",
"primaryKey": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
"array"
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
default
OPTIONS /dev/getAppDataStartKeys
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/getCurrentCacheKeys
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/getall
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/syncAppData
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/abandon-trip-booking
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/create-trip-booking
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/payment-balances
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/recover-abandoned-trip-booking
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/trip-booking
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-trip-booking
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/accommodations
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-accommodation
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-accommodation-guests
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-accommodation-room
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/delete-accommodation
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/delete-accommodation-guest
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/delete-accommodation-room
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-accommodation
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-accommodation-guest
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-accommodation-room
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/booking-details
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/booking-link
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-trip-booking-event
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/event-attendees
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/remove-trip-booking-event
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-event-attendees
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-trip-booking-member
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/get-trip-booking-members
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/remind-trip-booking-member
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/remove-trip-booking-member
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-trip-booking-member
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-ticket
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-ticket-bundle
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/assign-ticket
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/delete-ticket
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/delete-ticket-bundle
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/ticket-bundle
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/trip-booking-ticket-bundles
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-ticket
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-ticket-bundle
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/buildTrip
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/performerEvents
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/abandoned-trip-bookings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-crew-member
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/create-crew
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/crews
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/delete-crew
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/past-trip-bookings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/remove-crew-member
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/trip-bookings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-crew
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/discoverAny
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/discoverCitiesByDate
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/discoverDates
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/discoverPerformers
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/discoverPerformersInCities
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/performer-event-count
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/eventsForDate
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/eventsForTrip
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/continue-with-facebook
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/resend-code
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-phone-number
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/verify-code
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/downvoteImage
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/getImage
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/getStaticImage
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/upvoteImage
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/existing-members
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/send-invites-for-crew
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/like
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/likedTripIds
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/likedTrips
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/topLikedTrips
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/unlike
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/joinMailingList
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/mailing-settings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/sendAttachmentEmail
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/sendPlainEmail
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-mailing-settings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/push-notification-settings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-push-notification-settings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-user-push-endpoint
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/sms-settings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/update-sms-settings
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/updatedTickets
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/addTrendingEvent
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/getTrendingEvents
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/trending-cities
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/trending-performers
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/add-trip-idea
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/delete-trip-idea
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/like-trip-idea
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/trip-ideas
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/unlike-trip-idea
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/changepassword
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/editphonenumber
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/editprofile
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/enablemfa
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/facebook
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/facebookUpdatePhoneNumber
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/forgotpassword
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/getProfilePicture
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/login
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/login/newpassword
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/loginmfa
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/logout
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/mfastatus
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/preferences
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/refreshsession
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/resetpassword
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/signup
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/signup/confirm
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/signup/resend
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/updatepreferences
200 OK
200 response
Response Content-Types: application/json
OPTIONS /dev/verifyphonenumber
200 OK
200 response
Response Content-Types: application/json
booking
abandonTripBooking
Abandons a tripBooking.
undefined
Request Content-Types: application/json
Request Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"crewId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
createTripBooking
Creates a new tripBooking
undefined
Request Content-Types: application/json
Request Example
{
"endDate": "string",
"leaderIds": [
"string"
],
"crewId": "string",
"cityId": "string",
"startDate": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
paymentBalances
Returns the payment balances for a TripBooking.
id
The id of the tripBooking
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"paymentBalances": "array"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
recoverAbandonedTripBooking
Recovers an abandoned TripBooking.
undefined
Request Content-Types: application/json
Request Example
{
"forceRecovery": "boolean",
"crewId": "string",
"id": "string",
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
tripBooking
Returns the corresponding tripBooking
crewId
The id of crew that the tripBooking belongs to
type
string
in
query
userId
The krugoId of user accessing the tripBooking
type
string
in
query
id
The id of the tripBooking
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateTripBooking
Updates a tripBooking.
undefined
Request Content-Types: application/json
Request Example
{
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"accommodationIds": [
"string"
],
"userId": "string",
"startDate": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
bookingaccommodations
accommodations
Get accommodations by tripBookingId or accommodationId.
userId
The userId requesting the accommodations
type
string
in
query
tripBookingId
The tripBookingId to get all accommodations
type
string
in
query
id
The id for the accommodation.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"roomIds": [
"string"
],
"rooms": [
{
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"cityId": "string",
"name": "string",
"tripBookingId": "string",
"id": "string",
"state": "string",
"isSimpleBooking": "boolean"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
addAccommodation
Creates a new accommodation booking.
undefined
Request Content-Types: application/json
Request Example
{
"rooms": [
{
"checkOutDate": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"currency": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"guestId": "string",
"checkInDate": "string"
}
],
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"name": "string",
"tripBookingId": "string",
"cityId": "string",
"state": "string",
"userId": "string",
"isSimpleBooking": "boolean"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"roomIds": [
"string"
],
"rooms": [
{
"reservationId": "string",
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"cityId": "string",
"checkInDate": "string",
"checkOutDate": "string",
"name": "string",
"tripBookingId": "string",
"id": "string",
"state": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
addAccommodationGuests
Adds a new accommodation guest to an existing accommodation room.
undefined
Request Content-Types: application/json
Request Example
[
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
]
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
addAccommodationRoom
Adds a new accommodation room to an existing accommodation.
undefined
Request Content-Types: application/json
Request Example
{
"checkOutDate": "string",
"accommodationId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"currency": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"guestId": "string",
"checkInDate": "string"
}
],
"userId": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"reservationId": "string",
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
deleteAccommodation
Deletes an accommodation and any related objects.
undefined
Request Content-Types: application/json
Request Example
{
"tripBookingId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tripBookingId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
deleteAccommodationGuest
Deletes an accommodation guest.
undefined
Request Content-Types: application/json
Request Example
{
"id": "string",
"userId": "string",
"accommodationRoomId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string",
"accommodationRoomId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
deleteAccommodationRoom
Deletes an accommodation room and any related objects.
undefined
Request Content-Types: application/json
Request Example
{
"accommodationId": "string",
"id": "string",
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"accommodationId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateAccommodation
Updates high level details for an accommodation.
undefined
Request Content-Types: application/json
Request Example
{
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"name": "string",
"tripBookingId": "string",
"id": "string",
"cityId": "string",
"state": "string",
"userId": "string",
"isSimpleBooking": "boolean"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"roomIds": [
"string"
],
"rooms": [
{
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"cityId": "string",
"name": "string",
"tripBookingId": "string",
"id": "string",
"state": "string",
"isSimpleBooking": "boolean"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateAccommodationGuest
Updates accommodation guest details.
undefined
Request Content-Types: application/json
Request Example
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"userId": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateAccommodationRoom
Updates room and payment details for an accommodation.
undefined
Request Content-Types: application/json
Request Example
{
"checkOutDate": "string",
"accommodationId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string"
},
"id": "string",
"userId": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"checkOutDate": "string",
"accommodationId": "string",
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
bookingdotcom
bookingDetails
Returns booking details for the recently placed accommodation booking.
undefined
Request Content-Types: application/json
Request Example
{
"name": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
bookingLink
Returns a link for the requested city in booking.com
checkOutDate
The requested check out date (YYYY-MM-DD)
type
string
in
query
cityId
The cityId to check accommodations for
type
string
in
query
checkInDate
The requested check in date (YYYY-MM-DD)
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
bookingevents
addTripBookingEvent
Adds an event to a trip booking.
undefined
Request Content-Types: application/json
Request Example
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
eventAttendees
Returns the attendees for the events in a trip booking.
tripBookingId
The tripBookingId to retrieve event attendees for
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
removeTripBookingEvent
Removes an event from a trip booking and handles any ticket assignment accordingly.
undefined
Request Content-Types: application/json
Request Example
{
"eventId": "string",
"tripBookingId": "string",
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"tripBookingId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateEventAttendees
Updates who is attending a given event.
undefined
Request Content-Types: application/json
Request Example
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
bookingpeople
addTripBookingMember
Adds a user to an existing TripBooking
undefined
Request Content-Types: application/json
Request Example
{
"endDate": "string",
"isLeader": "boolean",
"isKrugoUser": "boolean",
"tripBookingId": "string",
"availability": "string",
"startDate": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"endDate": "string",
"isLeader": "boolean",
"bookingTripId": "string",
"isKrugoUser": "boolean",
"availability": "string",
"startDate": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getTripBookingMembers
Get a list of users for a given TripBooking
id
The tripBookingId to retrieve the members from
type
string
in
query
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"endDate": "string",
"isLeader": "boolean",
"imageUrl": "string",
"isKrugoUser": "boolean",
"tripBookingId": "string",
"availability": "string",
"userId": "string",
"startDate": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
remindTripBookingMember
Sends a reminder to a TripBooking member
undefined
Request Content-Types: application/json
Request Example
{
"tripBookingId": "string",
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"deliveryTime": "number",
"reminderType": "string",
"tripBookingId": "string",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
removeTripBookingMember
Removes a user from a TripBooking
undefined
Request Content-Types: application/json
Request Example
{
"tripBookingId": "string",
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tripBookingId": "string",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateTripBookingMember
Updates a user in a TripBooking
undefined
Request Content-Types: application/json
Request Example
{
"endDate": "string",
"isLeader": "boolean",
"tripBookingId": "string",
"availability": "string",
"startDate": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"endDate": "string",
"isLeader": "boolean",
"tripBookingId": "string",
"availability": "string",
"startDate": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
bookingtickets
addTicket
Adds a ticket to an existing ticketBundle
undefined
Request Content-Types: application/json
Request Example
{
"eventId": "string",
"purchaserId": "string",
"tripBookingId": "string",
"ticketBundleId": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
addTicketBundle
Adds a ticket bundle to a trip booking
undefined
Request Content-Types: application/json
Request Example
{
"isGeneralAdmission": "boolean",
"eventId": "string",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string"
}
],
"purchase": {
"date": "number",
"amount": "number",
"currency": "string"
},
"crewId": "string",
"tripBookingId": "string",
"isKrugoPurchase": "boolean"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"crewId": "string",
"tripBookingId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
assignTicket
Assigns a ticket to a Trip Booking Member. Can only be assigned by ticket purchaser or leader
undefined
Request Content-Types: application/json
Request Example
{
"tripBookingId": "string",
"ticketBundleId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
deleteTicket
Deletes a single ticket. Can only be deleted by ticket purchaser or leader
undefined
Request Content-Types: application/json
Request Example
{
"tripBookingId": "string",
"ticketBundleId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"ticketBundleId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
deleteTicketBundle
Deletes a ticket bundle. Can only be deleted by ticket purchaser or leader
undefined
Request Content-Types: application/json
Request Example
{
"tripBookingId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tripBookingId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
ticketBundle
Returns a ticket bundle with its associated tickets
id
The id of the ticketBundle
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"tripBookingId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
tripBookingTicketBundles
Returns all the ticket bundles and the associated tickets for a trip booking
id
The id of the tripBooking
type
string
in
query
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"tripBookingId": "string",
"id": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateTicket
Updates ticket details. Can only be updated by ticket purchaser or leader
undefined
Request Content-Types: application/json
Request Example
{
"eventId": "string",
"purchaserId": "string",
"tripBookingId": "string",
"ticketBundleId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateTicketBundle
Updates the ticket bundle, or if necessaary applies updates to all tickets in the bundle
undefined
Request Content-Types: application/json
Request Example
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string"
}
],
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string"
},
"userId": "string",
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"crewId": "string",
"tripBookingId": "string",
"id": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"crewId": "string",
"tripBookingId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
build
buildTrip
Creates a trip for a range range within a region.
undefined
Request Content-Types: application/json
Request Example
{
"regionId": "string",
"endDate": "string",
"startDate": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
performerEvents
Returns an array of events for a given performer.
performerId
The performerId to get events for.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
crews
abandonedTripBookings
Returns all the abandoned trip bookings for the given crew.
userId
The userId requesting the abandoned trip bookings
type
string
in
query
id
The requested crewId.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"unixEndDate": "number",
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"accommodationIds": [
"string"
],
"eventIds": [
"string"
],
"isPastTrip": "boolean",
"memberIds": [
"string"
],
"startDate": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
addCrewMember
Adds a new member to a crew.
undefined
Request Content-Types: application/json
Request Example
{
"newMemberId": "string",
"crewId": "string",
"isKrugoUser": "boolean",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"newMemberId": "string",
"crewId": "string",
"isKrugoUser": "boolean",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
createCrew
Creates a new crew.
undefined
Request Content-Types: application/json
Request Example
{
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"hasCrewImage": "boolean"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"isSoloCrew": "boolean",
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"id": "string",
"hasCrewImage": "boolean"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
crews
Gets all crews for a user.
id
The requested userId.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"adminIds": [
"string"
],
"imageUrl": "string",
"members": [
{
"imageUrl": "string",
"userId": "string"
}
],
"name": "string",
"description": "boolean",
"id": "string",
"hasCrewImage": "boolean"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
deleteCrew
Deletes a crew.
undefined
Request Content-Types: application/json
Request Example
{
"crewId": "string",
"userId": "string",
"removedMemberId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"crewId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
pastTripBookings
Returns all the past trip bookings for the given crew.
userId
The userId requesting the past trip bookings
type
string
in
query
id
The requested crewId.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"unixEndDate": "number",
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"accommodationIds": [
"string"
],
"eventIds": [
"string"
],
"isPastTrip": "boolean",
"memberIds": [
"string"
],
"startDate": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
removeCrewMember
Removes a member from a crew.
undefined
Request Content-Types: application/json
Request Example
{
"crewId": "string",
"userId": "string",
"removedMemberId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"removedMemberId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
tripBookings
Returns all the trip bookings for the given crew.
userId
The userId requesting the trip bookings
type
string
in
query
id
The requested crewId.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"unixEndDate": "number",
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"accommodationIds": [
"string"
],
"eventIds": [
"string"
],
"isPastTrip": "boolean",
"memberIds": [
"string"
],
"startDate": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateCrew
Updates a crews information of admins.
undefined
Request Content-Types: application/json
Request Example
{
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"id": "string",
"userId": "string",
"hasCrewImage": "boolean"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"id": "string",
"hasCrewImage": "boolean"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
discover
discoverAny
Discover trips for the given search query.
undefined
cacheKey
The hash of the performer ids to represent the cacheKey
type
string
in
query
Request Content-Types: application/json
Request Example
{
"queryPreferences": {
"flexibleDateCount": "number"
}
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
discoverCitiesByDate
Discover trips in select cities within a given date range.
undefined
cacheKey
The hash of the performer ids to represent the cacheKey
type
string
in
query
Request Content-Types: application/json
Request Example
{
"cities": [
"string"
],
"endDate": "string",
"startDate": "string",
"queryPreferences": {
"flexibleDateCount": "number"
}
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
discoverDates
Discover trips between a startDate and endDate.
undefined
cacheKey
The hash of the performer ids to represent the cacheKey
type
string
in
query
Request Content-Types: application/json
Request Example
{
"endDate": "string",
"startDate": "string",
"queryPreferences": {
"flexibleDateCount": "number"
}
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
discoverPerformers
Discover trips containing select performers.
undefined
cacheKey
The hash of the performer ids to represent the cacheKey
type
string
in
query
Request Content-Types: application/json
Request Example
{
"performers": [
"string"
],
"queryPreferences": {
"flexibleDateCount": "number"
}
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
discoverPerformersInCities
Discover trips containing select performers within given cities.
undefined
cacheKey
The hash of the performer ids to represent the cacheKey
type
string
in
query
Request Content-Types: application/json
Request Example
{
"performers": [
"string"
],
"cities": [
"string"
],
"queryPreferences": {
"flexibleDateCount": "number"
}
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
eventcount
performerEventCount
Returns an array of performers with their updated eventCount and nextEventDate properties.
undefined
cacheKey
The hash of the performer ids to represent the cacheKey
type
string
in
query
Request Content-Types: application/json
Request Example
{
"performerIds": [
"string"
]
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"eventCount": "number",
"id": "string",
"nextEventDate": "number"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
events
eventsForDate
Gets an array of events for a given day in a specific region.
undefined
Request Content-Types: application/json
Request Example
{
"date": "string",
"regionId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
eventsForTrip
Gets an array of events within given parameters.
undefined
Request Content-Types: application/json
Request Example
{
"endDate": "string",
"regionId": "string",
"excludedEvents": [
"string"
],
"startDate": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
continueWithFacebook
Continue with Facebook
undefined
Request Content-Types: application/json
Request Example
{
"fbToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string",
"facebookSession": {
"accessKeyId": "string",
"secretKey": "string",
"sessionToken": "string",
"expiration": "number"
}
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
resendCode
Resends an sms code to verify a Facebook users phone number.
undefined
Request Content-Types: application/json
Request Example
{
"id": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"deliveryMedium": "string",
"destination": "string",
"attributeName": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updatePhoneNumber
Update the phone number for a facebook user.
undefined
Request Content-Types: application/json
Request Example
{
"phoneNumber": "string",
"id": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"phoneNumber": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
verifyCode
Verifys the code for the users phone number.
undefined
Request Content-Types: application/json
Request Example
{
"code": "string",
"id": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"lastName": "string",
"firstName": "string",
"krugoId": "string",
"provider": "string",
"pushEndpoint": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string",
"phoneNumberConfirmed": "boolean"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
images
downvoteImage
Downvotes a given image
undefined
Request Content-Types: application/json
Request Example
{
"md5Hash": "string",
"id": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"result": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getImage
Returns image(s) based on user query
count
The number of images to return
type
string
in
query
cacheKey
(no description)
type
string
in
query
id
The id of the object the image represents
type
string
in
query
size
The image size to return: small, medium, large, thumbnail
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"md5Hash": "string",
"size": "string",
"author": "string",
"imageUrl": "string",
"name": "string",
"rank": "number",
"id": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getStaticImage
Returns static image(s) for within the app
count
The number of images to return
type
string
in
query
cacheKey
(no description)
type
string
in
query
id
The id that the image represents
type
string
in
query
size
The image size to return: small, medium, large, thumbnail
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"md5Hash": "string",
"size": "string",
"author": "string",
"imageUrl": "string",
"name": "string",
"rank": "number",
"id": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
upvoteImage
Upvotes a given image
undefined
Request Content-Types: application/json
Request Example
{
"md5Hash": "string",
"id": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"result": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
inviteusers
existingMembers
Returns existing members from a list of phone numbers.
phoneNumbers
Comma separated string containing the phone numbers to check
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"imageUrl": "string",
"isKrugoUser": "boolean",
"id": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
sendInvitesForCrew
Creates new tempUsers, sends invites, and adds users to a crew.
undefined
Request Content-Types: application/json
Request Example
{
"inviterUserId": "string",
"crewId": "string",
"newInvites": [
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"users": [
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"isKrugoUser": "boolean",
"id": "string"
}
]
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"isKrugoUser": "boolean",
"id": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
liketrip
like
Pushes liked trip into the like trip queue.
undefined
Request Content-Types: application/json
Request Example
{
"tripId": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tripId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
likedTripIds
Get all of the liked trips for a user.
id
The userId to retrieve likedTrips for
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"likedTripIds": [
"string"
]
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
likedTrips
Get all of the liked trips for a user.
undefined
Request Content-Types: application/json
Request Example
{
"likedTripIds": [
"string"
]
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"endDate": "string",
"primaryEventTypeId": "string",
"tripId": "string",
"eventCount": "number",
"lastLikeUnix": "number",
"cityId": "string",
"userId": "string",
"primaryCategoryId": "string",
"startDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
],
"likes": "number"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
topLikedTrips
Gets the top liked trips.
undefined
Request Content-Types: application/json
Request Example
{
"count": "number"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"endDate": "string",
"primaryEventTypeId": "string",
"tripId": "string",
"eventCount": "number",
"lastLikeUnix": "number",
"cityId": "string",
"userId": "string",
"primaryCategoryId": "string",
"startDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
],
"likes": "number"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
unlike
Pushes unliked trip into the unlike trip queue.
undefined
Request Content-Types: application/json
Request Example
{
"tripId": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tripId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
joinMailingList
Adds a user email to the mailing list for a given domain.
undefined
Request Content-Types: application/json
Request Example
{
"mailingList": "string",
"email": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
mailingSettings
Returns the mailing settings for a user.
userId
The userId to get settings for
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
sendAttachmentEmail
Send an email with an attachment
undefined
Request Content-Types: application/json
Request Example
{
"cc": "string",
"s3AttachmentPath": "string",
"bcc": "string",
"subject": "string",
"replyTo": "string",
"from": "string",
"html": "string",
"to": "string",
"text": "string",
"s3Bucket": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tmp": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
sendPlainEmail
Send a plain text email
undefined
Request Content-Types: application/json
Request Example
{
"cc": "string",
"bcc": "string",
"subject": "string",
"replyTo": "string",
"from": "string",
"html": "string",
"to": "string",
"text": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"tmp": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateMailingSettings
Updates the mailing settings for a user.
undefined
Request Content-Types: application/json
Request Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
pushnotifications
pushNotificationSettings
Updates the push notification settings for a user.
userId
The userId to get settings for
type
string
in
query
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updatePushNotificationSettings
Updates the push notification settings for a user.
undefined
Request Content-Types: application/json
Request Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateUserPushEndpoint
Updates the push notification ARN for a specific user.
undefined
Request Content-Types: application/json
Request Example
{
"userId": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"pushEndpoint": "string",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
servicerouter
route
Returns a list of all the services and their endpoints.
200 OK
200 response
Response Content-Types: application/json
route
Routes service requests to the correct microservice.
200 OK
200 response
Response Content-Types: application/json
smsnotifications
smsSettings
Returns the sms settings for a user.
userId
The userId to get settings for
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateSmsSettings
Updates the sms settings for a user.
undefined
Request Content-Types: application/json
Request Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
tickets
updatedTickets
Gets the updated listingCount, ticketCount, maxPrice, minPrice.
id
The id of the krugo event.
type
string
in
query
vividId
The vividId of the ticket
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"ticketCount": "number",
"listingCount": "number",
"minPrice": "number",
"maxPrice": "number"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
trending
addTrendingEvent
Adds a new trending event.
undefined
Request Content-Types: application/json
Request Example
{
"discoverQuery": {},
"action": "string",
"type": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getTrendingEvents
Gets an array of trending events.
undefined
Request Content-Types: application/json
Request Example
"object"
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"exclusiveStartTrendingKey": {
"dateCreated": "number",
"id": "string"
},
"exclusiveStartTopLikedKey": {
"primaryEventTypeId": "string",
"lastLikeUnix": "number",
"tripId": "string"
},
"trendingEvents": [
{
"backgroundColor": "string",
"icon": "string",
"type": "string",
"performerId": "string",
"discoverQuery": {
"performers": [
"string"
],
"regions": [
"string"
],
"cities": [
"string"
],
"endDate": "string",
"venues": [
"string"
],
"categories": [
"string"
],
"startDate": "string"
},
"dateCreated": "number",
"trip": {
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
},
"imageUrl": "string",
"action": "string",
"text": "string",
"id": "string",
"discoverQueryType": "string",
"fontColor": "string",
"categoryId": "string"
}
]
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
trendingCities
Gets the top trending cities.
countryCodes
The countryCodes to pull cities from. Comma separated string.
type
string
in
query
count
The number of trending cities to get.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"lng": "number",
"city": "string",
"regionId": "string",
"countryCode": "string",
"vividRegionId": "number",
"timezone": "string",
"searchCount": "number",
"id": "string",
"state": "string",
"lat": "number"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
trendingPerformers
Gets the top trending performers.
categoryIds
The categoryIds to pull performers from. Comma separated string.
type
string
in
query
count
The number of trending performers to get.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"vividId": "number",
"isParking": "boolean",
"searchCount": "number",
"secondaryCategoryId": "string",
"eventCount": "number",
"eventType": "string",
"priority": "number",
"cmsPath": "string",
"url": "string",
"eventTypeId": "string",
"name": "string",
"id": "string",
"vividCategoryId": "number",
"primaryCategoryId": "string",
"nextEventDate": "number",
"slug": "string"
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
tripideas
addTripIdea
Adds a trip idea to a crew.
undefined
Request Content-Types: application/json
Request Example
{
"endDate": "string",
"crewId": "string",
"likedUserIds": [
"string"
],
"suggestorId": "string",
"cityId": "string",
"eventIds": [
"string"
],
"startDate": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"endDate": "string",
"startDateUnix": "string",
"crewId": "string",
"likedUserIds": [
"string"
],
"suggestorId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"startDate": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
deleteTripIdea
Deletes a trip idea from a crew.
undefined
Request Content-Types: application/json
Request Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"crewId": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
likeTripIdea
Pushes a liked trip idea to the like trip idea queue.
undefined
Request Content-Types: application/json
Request Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"crewId": "string",
"id": "string",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
tripIdeas
Returns all trip ideas for a crew.
id
The crewId to retrieve tripIdeas for
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
[
{
"endDate": "string",
"startDateUnix": "number",
"crewId": "string",
"likedUserIds": [
"string"
],
"suggestorId": "string",
"cityId": "string",
"startDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
unlikeTripIdea
Pushes a liked trip idea to the unlike trip idea queue.
undefined
Request Content-Types: application/json
Request Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"crewId": "string",
"id": "string",
"userId": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
users
changepassword
Use this endpoint to change the user's password.
undefined
Request Content-Types: application/json
Request Example
{
"oldPassword": "string",
"newPassword": "string",
"username": "string",
"refreshToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"username": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
editphonenumber
Use this endpoint to change the user's phone number.
undefined
Request Content-Types: application/json
Request Example
{
"phoneNumber": "string",
"id": "string",
"username": "string",
"refreshToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"phoneNumber": "string",
"id": "string",
"username": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
editprofile
Use this endpoint to edit all user attributes except phone
undefined
Request Content-Types: application/json
Request Example
{
"updateAttributes": [
{
"Value": "string",
"Name": "string"
}
],
"username": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"provider": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
enablemfa
Sets the enablemfa property to true/false.
undefined
Request Content-Types: application/json
Request Example
{
"enableMfa": "boolean",
"username": "string",
"refreshToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"enableMfa": "boolean",
"username": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
Continue with Facebook
undefined
Request Content-Types: application/json
Request Example
{
"fbToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string",
"facebookSession": {
"accessKeyId": "string",
"secretKey": "string",
"sessionToken": "string",
"expiration": "number"
}
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
facebookUpdatePhoneNumber
Update the phone number for a facebook user.
undefined
Request Content-Types: application/json
Request Example
{
"phoneNumber": "string",
"id": "string"
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"phoneNumber": "string",
"id": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
forgotpassword
Start a forgot password flow. Cognito will send a passwordResetCode to one of the user's confirmed contact methods (email or SMS) to be used in the passwordReset method below.
undefined
Request Content-Types: application/json
Request Example
{
"username": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"Destination": "string",
"DeliveryMedium": "string",
"AttributeName": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getProfilePicture
Gets the users profile picture.
id
The userId to get the profile picture for
type
string
in
query
size
The size of image to return.
type
string
in
query
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"profilePictureUrl": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
login
Login an existing and confirmed user
undefined
Request Content-Types: application/json
Request Example
{
"password": "string",
"username": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"cognitoSession": {},
"phonenumber": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
loginnewpassword
Using the information from the login method
undefined
Request Content-Types: application/json
Request Example
{
"newPassword": "string",
"loginSession": "string",
"username": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"username": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
loginmfa
Using the information from the login method and the mfaCode received by SMS
undefined
Request Content-Types: application/json
Request Example
{
"cognitoUsername": "string",
"mfaCode": "string",
"loginSession": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
logout
This method invalidates all issued tokens
undefined
Request Content-Types: application/json
Request Example
{
"username": "string",
"refreshToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"username": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getmfastatus
If MFA is enabled for this user, retrieve its options. Otherwise, returns undefined.
undefined
Request Content-Types: application/json
Request Example
{
"username": "string",
"refreshToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"mfaEnabled": "boolean"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
getUserPreferences
Get the user preferences for a given user.
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"preferredTripLength": "number",
"homeCity": "string",
"favoriteEventTypes": [
"string"
],
"favoriteCategories": [
"string"
],
"userId": "string",
"favoritePerformers": [
"string"
],
"preferredStartDate": "string",
"preferredEndDate": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
refreshsession
Generate new refreshToken, idToken and accessToken with a new expiry date.
undefined
Request Content-Types: application/json
Request Example
{
"username": "string",
"refreshToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"cognitoSession": {},
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
resetpassword
Finish the forgot password flow.
undefined
Request Content-Types: application/json
Request Example
{
"newPassword": "string",
"passwordResetCode": "string",
"username": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"username": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
signup
Signup a new user
undefined
Request Content-Types: application/json
Request Example
{
"password": "string",
"firstname": "string",
"attributes": [
{
"Value": "string",
"Name": "string"
}
],
"username": "string",
"lastname": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"gender": "string",
"provider": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
signupconfirm
Depending on your settings, email confirmation may be required.
undefined
Request Content-Types: application/json
Request Example
{
"confirmationCode": "string",
"password": "string",
"username": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"lastName": "string",
"gender": "string",
"pushEndpoint": "string",
"cognitoSession": {},
"phonenumber": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"phoneNumberConfirmed": "boolean",
"firstName": "string",
"provider": "string",
"krugoId": "string",
"name": "string",
"id": "string",
"email": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
signupresend
If the user didn't receive the signup confirmation code, they may request a new code
undefined
Request Content-Types: application/json
Request Example
{
"username": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"Destination": "string",
"DeliveryMedium": "string",
"AttributeName": "string"
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
updateUserPreferences
Updates the user preferences for a given user.
undefined
Request Content-Types: application/json
Request Example
{
"eventTypeSportsEnabled": "boolean",
"tripLength": "number",
"tripStartDay": "number",
"favoriteCategoryIds": [
"string"
],
"tripEndDay": "number",
"tripViewRange": "number",
"id": "string",
"favoriteCityIds": [
"string"
],
"eventTypeConcertsEnabled": "boolean",
"eventTypeTheaterEnabled": "boolean",
"favoritePerformerIds": [
"string"
]
}
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
{
"eventTypeSportsEnabled": "boolean",
"tripLength": "number",
"tripStartDay": "number",
"favoriteCategoryIds": [
"string"
],
"tripEndDay": "number",
"tripViewRange": "number",
"id": "string",
"eventTypeConcertsEnabled": "boolean",
"eventTypeTheaterEnabled": "boolean",
"favoritePerformerIds": [
"string"
]
}
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
verifyphonenumber
Use this endpoint to verify the user's new phone number.
undefined
Request Content-Types: application/json
Request Example
{
"code": "string",
"id": "string",
"accessToken": "string"
}
200 OK
200 response
400 Bad Request
400 response
Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (400 Bad Request)
{
"message": "string",
"statusCode": "number"
}
Schema Definitions
400JsonResponse: object
An error occurred.
- message: string
- statusCode: number
Example
{
"message": "string",
"statusCode": "number"
}
getCurrentCacheKeysResponse: object[]
Most up to date cache keys for app data.
- lastUpdated: number
- secondaryKey: string
- primaryKey: string
- objectType: string
Example
[
{
"lastUpdated": "number",
"secondaryKey": "string",
"primaryKey": "string",
"objectType": "string"
}
]
getAppDataStartKeysResponse: object[]
Gets a list of appData start keys to enable async data retrieval.
- startKey: string
- sortKey: string
- startKeyName: string
- sortKeyName: string
- table: string
Example
[
{
"startKey": "string",
"sortKey": "string",
"startKeyName": "string",
"sortKeyName": "string",
"table": "string"
}
]
syncAppDataRequest: object
Gets all updated appData that the client is missing.
- secondaryKey: string
- primaryKey: string
Example
{
"secondaryKey": "string",
"primaryKey": "string"
}
getallRequest: object
Gets items based on a given table and its start keys.
- startKey: string
- sortKey: string
- startKeyName: string
- sortKeyName: string
- table: string
- baseTableName: string
Example
{
"startKey": "string",
"sortKey": "string",
"startKeyName": "string",
"sortKeyName": "string",
"table": "string",
"baseTableName": "string"
}
abandonTripBookingRequest: object
Abandons a tripBooking.
- crewId: string
- id: string
- userId: string
Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
abandonTripBookingResponse: object
Returns the id of the TripBooking that was abandoned
- crewId: string
- id: string
Example
{
"crewId": "string",
"id": "string"
}
updateTripBookingRequest: object
Updates a tripBooking.
- endDate: string
- leaderIds: string[]
- ticketBundleIds: string[]
- crewId: string
- id: string
- accommodationIds: string[]
- userId: string
- startDate: string
Example
{
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"accommodationIds": [
"string"
],
"userId": "string",
"startDate": "string"
}
recoverAbandonedTripBookingResponse: object
Returns the recovered tripBooking
- tempMemberIds: string[]
- endDate: string
- leaderIds: string[]
- ticketBundleIds: string[]
- crewId: string
- id: string
- cityId: string
- eventIds: string[]
- accommodationIds: string[]
- startDate: string
- memberIds: string[]
- isPastTrip: string
Example
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
createTripBookingRequest: object
Creates a new tripBooking
- endDate: string
- leaderIds: string[]
- crewId: string
- cityId: string
- startDate: string
Example
{
"endDate": "string",
"leaderIds": [
"string"
],
"crewId": "string",
"cityId": "string",
"startDate": "string"
}
paymentBalancesResponse: object
Returns the outstanding payment balances for the members of the given TripBooking
- paymentBalances: array
Example
{
"paymentBalances": "array"
}
createTripBookingResponse: object
Returns the newly created TripBooking
- tempMemberIds: string[]
- endDate: string
- leaderIds: string[]
- ticketBundleIds: string[]
- crewId: string
- id: string
- cityId: string
- eventIds: string[]
- accommodationIds: string[]
- startDate: string
- memberIds: string[]
- isPastTrip: string
Example
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
recoverAbandonedTripBookingRequest: object
Recovers an abandoned tripBooking.
- forceRecovery: boolean
- crewId: string
- id: string
- userId: string
Example
{
"forceRecovery": "boolean",
"crewId": "string",
"id": "string",
"userId": "string"
}
tripBookingResponse: object
Returns the TripBooking matching the given id
- tempMemberIds: string[]
- endDate: string
- leaderIds: string[]
- ticketBundleIds: string[]
- crewId: string
- id: string
- cityId: string
- eventIds: string[]
- accommodationIds: string[]
- startDate: string
- memberIds: string[]
- isPastTrip: string
Example
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
updateTripBookingResponse: object
Returns the newly updated TripBooking
- endDate: string
- leaderIds: string[]
- ticketBundleIds: string[]
- crewId: string
- id: string
- eventIds: string[]
- accommodationIds: string[]
- startDate: string
- memberIds: string[]
- isPastTrip: string
Example
{
"endDate": "string",
"leaderIds": [
"string"
],
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"eventIds": [
"string"
],
"accommodationIds": [
"string"
],
"startDate": "string",
"memberIds": [
"string"
],
"isPastTrip": "string"
}
deleteAccommodationGuestRequest: object
The accommodationRoomId and accommodationGuestId to be deleted.
- id: string
- userId: string
- accommodationRoomId: string
Example
{
"id": "string",
"userId": "string",
"accommodationRoomId": "string"
}
addAccommodationRoomRequest: object
An accommodation room object to be created.
- checkOutDate: string
- accommodationId: string
- purchase: object
- guests: object[]
- userId: string
- checkInDate: string
- roomTypeId: number
Example
{
"checkOutDate": "string",
"accommodationId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"currency": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"guestId": "string",
"checkInDate": "string"
}
],
"userId": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
updateAccommodationRoomResponse: object
The updated accommodation room.
- checkOutDate: string
- accommodationId: string
- purchaseId: string
- purchase: object
- id: string
- checkInDate: string
- roomTypeId: number
Example
{
"checkOutDate": "string",
"accommodationId": "string",
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
deleteAccommodationResponse: object
Returns the id of the removed accommodation.
- tripBookingId: string
- id: string
Example
{
"tripBookingId": "string",
"id": "string"
}
addAccommodationRequest: object
An accommodation object to be created.
- rooms: object[]
- address: string
- city: string
- hotelTypeId: number
- accommodationGuestUserIds: string[]
- name: string
- tripBookingId: string
- cityId: string
- state: string
- userId: string
- isSimpleBooking: boolean
Example
{
"rooms": [
{
"checkOutDate": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"currency": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"guestId": "string",
"checkInDate": "string"
}
],
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"name": "string",
"tripBookingId": "string",
"cityId": "string",
"state": "string",
"userId": "string",
"isSimpleBooking": "boolean"
}
updateAccommodationRoomRequest: object
The updated accommodation room.
- checkOutDate: string
- accommodationId: string
- purchase: object
- id: string
- userId: string
- checkInDate: string
- roomTypeId: number
Example
{
"checkOutDate": "string",
"accommodationId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string"
},
"id": "string",
"userId": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
addAccommodationGuestsResponse: object[]
Returns the newly created accommodation guest.
- checkOutDate: string
- proportionOfPayment: number
- id: string
- guestId: string
- checkInDate: string
- accommodationRoomId: string
Example
[
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
]
deleteAccommodationRoomResponse: object
Returns the id of the removed accommodation room.
- accommodationId: string
- id: string
Example
{
"accommodationId": "string",
"id": "string"
}
deleteAccommodationGuestResponse: object
Returns the id of the removed accommodation guest.
- id: string
- accommodationRoomId: string
Example
{
"id": "string",
"accommodationRoomId": "string"
}
addAccommodationGuestsRequest: object[]
An accommodation guest object to be created.
- checkOutDate: string
- proportionOfPayment: number
- guestId: string
- checkInDate: string
- accommodationRoomId: string
Example
[
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
]
addAccommodationResponse: object
Returns the newly created accommodation.
- roomIds: string[]
- rooms: object[]
- address: string
- city: string
- hotelTypeId: number
- cityId: string
- checkInDate: string
- checkOutDate: string
- name: string
- tripBookingId: string
- id: string
- state: string
Example
{
"roomIds": [
"string"
],
"rooms": [
{
"reservationId": "string",
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"cityId": "string",
"checkInDate": "string",
"checkOutDate": "string",
"name": "string",
"tripBookingId": "string",
"id": "string",
"state": "string"
}
updateAccommodationResponse: object
The updated accommodation.
- roomIds: string[]
- rooms: object[]
- address: string
- city: string
- hotelTypeId: number
- accommodationGuestUserIds: string[]
- cityId: string
- name: string
- tripBookingId: string
- id: string
- state: string
- isSimpleBooking: boolean
Example
{
"roomIds": [
"string"
],
"rooms": [
{
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"cityId": "string",
"name": "string",
"tripBookingId": "string",
"id": "string",
"state": "string",
"isSimpleBooking": "boolean"
}
addAccommodationRoomResponse: object
Returns the newly created accommodation room.
- reservationId: string
- checkOutDate: string
- accommodationId: string
- guestIds: string[]
- purchaseId: string
- purchase: object
- guests: object[]
- id: string
- checkInDate: string
- roomTypeId: number
Example
{
"reservationId": "string",
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
deleteAccommodationRequest: object
The tripBookingId and accommodationId to be deleted.
- tripBookingId: string
- id: string
- userId: string
Example
{
"tripBookingId": "string",
"id": "string",
"userId": "string"
}
accommodationsResponse: object[]
Returns an array of accommodation(s)
- roomIds: string[]
- rooms: object[]
- address: string
- city: string
- hotelTypeId: number
- accommodationGuestUserIds: string[]
- cityId: string
- name: string
- tripBookingId: string
- id: string
- state: string
- isSimpleBooking: boolean
Example
[
{
"roomIds": [
"string"
],
"rooms": [
{
"checkOutDate": "string",
"accommodationId": "string",
"guestIds": [
"string"
],
"purchaseId": "string",
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"type": "string"
},
"guests": [
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
],
"id": "string",
"checkInDate": "string",
"roomTypeId": "number"
}
],
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"cityId": "string",
"name": "string",
"tripBookingId": "string",
"id": "string",
"state": "string",
"isSimpleBooking": "boolean"
}
]
updateAccommodationGuestResponse: object
The updated accommodation guest.
- checkOutDate: string
- proportionOfPayment: number
- id: string
- guestId: string
- checkInDate: string
- accommodationRoomId: string
Example
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
updateAccommodationRequest: object
The updated accommodation.
- address: string
- city: string
- hotelTypeId: number
- accommodationGuestUserIds: string[]
- name: string
- tripBookingId: string
- id: string
- cityId: string
- state: string
- userId: string
- isSimpleBooking: boolean
Example
{
"address": "string",
"city": "string",
"hotelTypeId": "number",
"accommodationGuestUserIds": [
"string"
],
"name": "string",
"tripBookingId": "string",
"id": "string",
"cityId": "string",
"state": "string",
"userId": "string",
"isSimpleBooking": "boolean"
}
updateAccommodationGuestRequest: object
The updated accommodation guest.
- checkOutDate: string
- proportionOfPayment: number
- id: string
- userId: string
- guestId: string
- checkInDate: string
- accommodationRoomId: string
Example
{
"checkOutDate": "string",
"proportionOfPayment": "number",
"id": "string",
"userId": "string",
"guestId": "string",
"checkInDate": "string",
"accommodationRoomId": "string"
}
deleteAccommodationRoomRequest: object
The accommodationId and accommodationRoomId to be deleted.
- accommodationId: string
- id: string
- userId: string
Example
{
"accommodationId": "string",
"id": "string",
"userId": "string"
}
bookingDetailsResponse: object
Returns the details for the recently reserved accommodation
- name: string
Example
{
"name": "string"
}
bookingDetailsRequest: object
The success url from the booking.com web portal
- name: string
Example
{
"name": "string"
}
bookingLinkResponse: object
Returns a link for booking.com
- name: string
Example
{
"name": "string"
}
updateEventAttendeesResponse: object
Return the updated trip booking event attendees.
- eventId: string
- userIds: string[]
- tripBookingId: string
Example
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string"
}
removeTripBookingEventResponse: object
Return the id's of the trip booking event that was removed.
- eventId: string
- tripBookingId: string
Example
{
"eventId": "string",
"tripBookingId": "string"
}
addTripBookingEventResponse: object
Return the newly created trip boooking event.
- eventId: string
- userIds: string[]
- tripBookingId: string
Example
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string"
}
removeTripBookingEventRequest: object
The tripBookingId and eventId to delete
- eventId: string
- tripBookingId: string
- userId: string
Example
{
"eventId": "string",
"tripBookingId": "string",
"userId": "string"
}
addTripBookingEventRequest: object
Adds a new event to a trip booking.
- eventId: string
- userIds: string[]
- tripBookingId: string
- userId: string
Example
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string",
"userId": "string"
}
updateEventAttendeesRequest: object
Updated attendees list for a given trip booking event.
- eventId: string
- userIds: string[]
- tripBookingId: string
- userId: string
Example
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string",
"userId": "string"
}
eventAttendeesResponse: object[]
Returns the events and respective attendees for a given trip booking.
- eventId: string
- userIds: string[]
- tripBookingId: string
Example
[
{
"eventId": "string",
"userIds": [
"string"
],
"tripBookingId": "string"
}
]
getTripBookingMembersResponse: object[]
Returns the userIds of TripBooking members
- firstName: string
- lastName: string
- phoneNumber: string
- endDate: string
- isLeader: boolean
- imageUrl: string
- isKrugoUser: boolean
- tripBookingId: string
- availability: string , x ∈ { going , undecided , notgoing }
- userId: string
- startDate: string
Example
[
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"endDate": "string",
"isLeader": "boolean",
"imageUrl": "string",
"isKrugoUser": "boolean",
"tripBookingId": "string",
"availability": "string",
"userId": "string",
"startDate": "string"
}
]
removeTripBookingMemberRequest: object
Removes a user from a TripBooking
- tripBookingId: string
- userId: string
Example
{
"tripBookingId": "string",
"userId": "string"
}
updateTripBookingMemberResponse: object
Returns the updated TripBooking member
- endDate: string
- isLeader: boolean
- tripBookingId: string
- availability: string , x ∈ { going , undecided , notgoing }
- startDate: string
Example
{
"endDate": "string",
"isLeader": "boolean",
"tripBookingId": "string",
"availability": "string",
"startDate": "string"
}
remindTripBookingMemberResponse: object
Returns the userId and delivery method of the reminder
- deliveryTime: number
- reminderType: string , x ∈ { sms , push , email }
- tripBookingId: string
- userId: string
Example
{
"deliveryTime": "number",
"reminderType": "string",
"tripBookingId": "string",
"userId": "string"
}
updateTripBookingMemberRequest: object
Updates a user in a TripBooking
- endDate: string
- isLeader: boolean
- tripBookingId: string
- availability: string , x ∈ { going , undecided , notgoing }
- startDate: string
Example
{
"endDate": "string",
"isLeader": "boolean",
"tripBookingId": "string",
"availability": "string",
"startDate": "string"
}
remindTripBookingMemberRequest: object
Sends a reminder to a TripBooking member
- tripBookingId: string
- userId: string
Example
{
"tripBookingId": "string",
"userId": "string"
}
addTripBookingMemberRequest: object
Adds a user to an existing TripBooking
- endDate: string
- isLeader: boolean
- isKrugoUser: boolean
- tripBookingId: string
- availability: string , x ∈ { going , undecided , notgoing }
- startDate: string
Example
{
"endDate": "string",
"isLeader": "boolean",
"isKrugoUser": "boolean",
"tripBookingId": "string",
"availability": "string",
"startDate": "string"
}
addTripBookingMemberResponse: object
The TripBooking id and members
- endDate: string
- isLeader: boolean
- bookingTripId: string
- isKrugoUser: boolean
- availability: string , x ∈ { going , undecided , notgoing }
- startDate: string
Example
{
"endDate": "string",
"isLeader": "boolean",
"bookingTripId": "string",
"isKrugoUser": "boolean",
"availability": "string",
"startDate": "string"
}
removeTripBookingMemberResponse: object
Returns the userId of the removed member
- tripBookingId: string
- userId: string
Example
{
"tripBookingId": "string",
"userId": "string"
}
tripBookingTicketBundlesResponse: object[]
Returns all the ticket bundles and the associated tickets for a trip booking.
- eventId: string
- tickets: object[]
- purchase: object
- isKrugoPurchase: boolean
- isGeneralAdmission: boolean
- isSpecialSeating: boolean
- purchaserId: string
- numberOfTickets: number
- tripBookingId: string
- id: string
Example
[
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"tripBookingId": "string",
"id": "string"
}
]
deleteTicketBundleRequest: object
Deletes a ticket bundle. Can only be deleted by ticket purchaser or leader
- tripBookingId: string
- id: string
- userId: string
Example
{
"tripBookingId": "string",
"id": "string",
"userId": "string"
}
addTicketBundleRequest: object
Adds a ticket bundle to a bookingTrip
- isGeneralAdmission: boolean
- eventId: string
- isSpecialSeating: boolean
- purchaserId: string
- tickets: object[]
- purchase: object
- crewId: string
- tripBookingId: string
- isKrugoPurchase: boolean
Example
{
"isGeneralAdmission": "boolean",
"eventId": "string",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string"
}
],
"purchase": {
"date": "number",
"amount": "number",
"currency": "string"
},
"crewId": "string",
"tripBookingId": "string",
"isKrugoPurchase": "boolean"
}
addTicketResponse: object
Returns the added ticket details.
- eventId: string
- purchaserId: string
- consumerId: string
- ticketBundleId: string
- id: string
Example
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
assignTicketRequest: object
Assigns a ticket to a Trip Booking Member. Can only be assigned by ticket purchaser or leader
- tripBookingId: string
- ticketBundleId: string
- id: string
- userId: string
Example
{
"tripBookingId": "string",
"ticketBundleId": "string",
"id": "string",
"userId": "string"
}
addTicketRequest: object
Adds a ticket to an existing ticketBundle
- eventId: string
- purchaserId: string
- tripBookingId: string
- ticketBundleId: string
- userId: string
Example
{
"eventId": "string",
"purchaserId": "string",
"tripBookingId": "string",
"ticketBundleId": "string",
"userId": "string"
}
updateTicketResponse: object
Returns the updated ticket.
- eventId: string
- purchaserId: string
- consumerId: string
- ticketBundleId: string
- id: string
Example
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
updateTicketBundleResponse: object
Returns the updated ticketBundle.
- eventId: string
- tickets: object[]
- purchase: object
- isKrugoPurchase: boolean
- isGeneralAdmission: boolean
- isSpecialSeating: boolean
- purchaserId: string
- numberOfTickets: number
- crewId: string
- tripBookingId: string
- id: string
Example
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"crewId": "string",
"tripBookingId": "string",
"id": "string"
}
ticketBundleResponse: object
Returns a ticket bundle with its associated tickets.
- eventId: string
- tickets: object[]
- purchase: object
- isKrugoPurchase: boolean
- isGeneralAdmission: boolean
- isSpecialSeating: boolean
- purchaserId: string
- numberOfTickets: number
- tripBookingId: string
- id: string
Example
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"tripBookingId": "string",
"id": "string"
}
updateTicketBundleRequest: object
Updates the ticket bundle, or if necessaary applies updates to all tickets in the bundle
- eventId: string
- tickets: object[]
- purchase: object
- userId: string
- isKrugoPurchase: boolean
- isGeneralAdmission: boolean
- isSpecialSeating: boolean
- purchaserId: string
- numberOfTickets: number
- crewId: string
- tripBookingId: string
- id: string
Example
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string"
}
],
"purchase": {
"date": "number",
"amount": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string"
},
"userId": "string",
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"crewId": "string",
"tripBookingId": "string",
"id": "string"
}
deleteTicketRequest: object
Deletes a single ticket. Can only be deleted by ticket purchaser or leader
- tripBookingId: string
- ticketBundleId: string
- id: string
- userId: string
Example
{
"tripBookingId": "string",
"ticketBundleId": "string",
"id": "string",
"userId": "string"
}
updateTicketRequest: object
Updates ticket details. Can only be updated by ticket purchaser or leader
- eventId: string
- purchaserId: string
- tripBookingId: string
- ticketBundleId: string
- id: string
- userId: string
Example
{
"eventId": "string",
"purchaserId": "string",
"tripBookingId": "string",
"ticketBundleId": "string",
"id": "string",
"userId": "string"
}
deleteTicketResponse: object
Returns the id of the deleted ticket.
- ticketBundleId: string
- id: string
Example
{
"ticketBundleId": "string",
"id": "string"
}
addTicketBundleResponse: object
Returns the full ticket bundle.
- eventId: string
- tickets: object[]
- purchase: object
- isKrugoPurchase: boolean
- isGeneralAdmission: boolean
- isSpecialSeating: boolean
- purchaserId: string
- numberOfTickets: number
- crewId: string
- tripBookingId: string
- id: string
Example
{
"eventId": "string",
"tickets": [
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
],
"purchase": {
"date": "number",
"purchaserId": "string",
"tripBookingId": "string",
"currency": "string",
"id": "string",
"purchasePrice": "number",
"type": "string"
},
"isKrugoPurchase": "boolean",
"isGeneralAdmission": "boolean",
"isSpecialSeating": "boolean",
"purchaserId": "string",
"numberOfTickets": "number",
"crewId": "string",
"tripBookingId": "string",
"id": "string"
}
assignTicketResponse: object
Returns the newly assigned ticket.
- eventId: string
- purchaserId: string
- consumerId: string
- ticketBundleId: string
- id: string
Example
{
"eventId": "string",
"purchaserId": "string",
"consumerId": "string",
"ticketBundleId": "string",
"id": "string"
}
deleteTicketBundleResponse: object
Returns the id of the deleted ticket bundle.
- tripBookingId: string
- id: string
Example
{
"tripBookingId": "string",
"id": "string"
}
performerEventsResponse: object[]
Returns an array of events for a given performer.
- listingCount: number
- vividId: number
- timezone: string
- totalPerformerRank: number
- searchCount: number
- vividVenueId: number
- cityId: string
- performerId: string
- masterPerformer: boolean
- venueId: string
- eventName: string
- id: string
- eventDateString: string
- ticketCount: number
- vividPerformerId: number
- url: string
- chartUrl: string
- eventDay: string
- eventTypeId: string
- regionId: string
- vividRegionId: number
- minPrice: number
- ageRestriction: number
- maxPrice: number
- secondaryPerformerIds: string[]
- eventDate: number
Example
[
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
buildTripRequest: object
Takes dates and location to build an empty trip for the user.
- regionId: string
- endDate: string
- startDate: string
Example
{
"regionId": "string",
"endDate": "string",
"startDate": "string"
}
buildTripResponse: object
Returns an empty trip based on dates and location.
- tripStartDate: string
- regionId: string
- flexibleStartDate: string
- timezone: string
- flexibleEndDate: string
- tripEndDate: string
- events: object[]
Example
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
createCrewRequest: object
Creates a new crew.
- adminIds: string[]
- name: string
- description: boolean
- hasCrewImage: boolean
Example
{
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"hasCrewImage": "boolean"
}
tripBookingsResponse: object
Returns the trip booking.
- tempMemberIds: string[]
- endDate: string
- leaderIds: string[]
- unixEndDate: number
- ticketBundleIds: string[]
- crewId: string
- id: string
- accommodationIds: string[]
- eventIds: string[]
- isPastTrip: boolean
- memberIds: string[]
- startDate: string
Example
{
"tempMemberIds": [
"string"
],
"endDate": "string",
"leaderIds": [
"string"
],
"unixEndDate": "number",
"ticketBundleIds": [
"string"
],
"crewId": "string",
"id": "string",
"accommodationIds": [
"string"
],
"eventIds": [
"string"
],
"isPastTrip": "boolean",
"memberIds": [
"string"
],
"startDate": "string"
}
crewsResponse: object[]
Returns the crews for a given user.
- adminIds: string[]
- imageUrl: string
- members: object[]
- name: string
- description: boolean
- id: string
- hasCrewImage: boolean
Example
[
{
"adminIds": [
"string"
],
"imageUrl": "string",
"members": [
{
"imageUrl": "string",
"userId": "string"
}
],
"name": "string",
"description": "boolean",
"id": "string",
"hasCrewImage": "boolean"
}
]
addCrewMemberRequest: object
Adds a new member to a crew.
- newMemberId: string
- crewId: string
- isKrugoUser: boolean
- userId: string
Example
{
"newMemberId": "string",
"crewId": "string",
"isKrugoUser": "boolean",
"userId": "string"
}
addCrewMemberResponse: object
Returns the newly added crew member.
- newMemberId: string
- crewId: string
- isKrugoUser: boolean
- userId: string
Example
{
"newMemberId": "string",
"crewId": "string",
"isKrugoUser": "boolean",
"userId": "string"
}
removeCrewMemberRequest: object
Removes a member from a crew.
- crewId: string
- userId: string
- removedMemberId: string
Example
{
"crewId": "string",
"userId": "string",
"removedMemberId": "string"
}
updateCrewRequest: object
Updates a crews information of admins.
- adminIds: string[]
- name: string
- description: boolean
- id: string
- userId: string
- hasCrewImage: boolean
Example
{
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"id": "string",
"userId": "string",
"hasCrewImage": "boolean"
}
removeCrewMemberResponse: object
Returns the removed crew member.
- removedMemberId: string
Example
{
"removedMemberId": "string"
}
deleteCrewResponse: object
Returns the the deleted crewId.
- crewId: string
Example
{
"crewId": "string"
}
deleteCrewRequest: object
Deletes a crew.
- crewId: string
- userId: string
- removedMemberId: string
Example
{
"crewId": "string",
"userId": "string",
"removedMemberId": "string"
}
updateCrewResponse: object
Returns the updated crew.
- adminIds: string[]
- name: string
- description: boolean
- id: string
- hasCrewImage: boolean
Example
{
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"id": "string",
"hasCrewImage": "boolean"
}
createCrewResponse: object
Returns the newly created crew.
- isSoloCrew: boolean
- adminIds: string[]
- name: string
- description: boolean
- id: string
- hasCrewImage: boolean
Example
{
"isSoloCrew": "boolean",
"adminIds": [
"string"
],
"name": "string",
"description": "boolean",
"id": "string",
"hasCrewImage": "boolean"
}
discoverCitiesByDateRequest: object
Discover trips in select cities within a given date range.
- cities: string[]
- endDate: string
- startDate: string
- queryPreferences: object
Example
{
"cities": [
"string"
],
"endDate": "string",
"startDate": "string",
"queryPreferences": {
"flexibleDateCount": "number"
}
}
discoverResponse: object[]
Trip results from the search query.
- tripStartDate: string
- regionId: string
- flexibleStartDate: string
- timezone: string
- flexibleEndDate: string
- eventCount: number
- tripEndDate: string
- events: object[]
Example
[
{
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
discoverAnyRequest: object
Discover trips for the given search query.
- queryPreferences: object
Example
{
"queryPreferences": {
"flexibleDateCount": "number"
}
}
discoverPerformersInCitiesRequest: object
Discover trips containing select performers within given cities.
- performers: string[]
- cities: string[]
- queryPreferences: object
Example
{
"performers": [
"string"
],
"cities": [
"string"
],
"queryPreferences": {
"flexibleDateCount": "number"
}
}
discoverDatesRequest: object
Perform a search using only a startDate and endDate as parameters.
- endDate: string
- startDate: string
- queryPreferences: object
Example
{
"endDate": "string",
"startDate": "string",
"queryPreferences": {
"flexibleDateCount": "number"
}
}
discoverPerformersRequest: object
Discover trips containing select performers.
- performers: string[]
- queryPreferences: object
Example
{
"performers": [
"string"
],
"queryPreferences": {
"flexibleDateCount": "number"
}
}
performerEventCountRequest: object
An array of performerIds to get the updated eventCount and nextEventDate for
- performerIds: string[]
Example
{
"performerIds": [
"string"
]
}
performerEventCountResponse: object[]
Returns an array of performerIds and their respective eventCount and nextEventDate
- eventCount: number
- id: string
- nextEventDate: number
Example
[
{
"eventCount": "number",
"id": "string",
"nextEventDate": "number"
}
]
eventsForDateResponse: object[]
Returns an array of events.
- listingCount: number
- vividId: number
- timezone: string
- totalPerformerRank: number
- searchCount: number
- vividVenueId: number
- cityId: string
- performerId: string
- masterPerformer: boolean
- venueId: string
- eventName: string
- id: string
- eventDateString: string
- ticketCount: number
- vividPerformerId: number
- url: string
- chartUrl: string
- eventDay: string
- eventTypeId: string
- regionId: string
- vividRegionId: number
- minPrice: number
- ageRestriction: number
- maxPrice: number
- secondaryPerformerIds: string[]
- eventDate: number
Example
[
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
eventsForTripResponse: object[]
Returns an array of events.
- listingCount: number
- vividId: number
- timezone: string
- totalPerformerRank: number
- searchCount: number
- vividVenueId: number
- cityId: string
- performerId: string
- masterPerformer: boolean
- venueId: string
- eventName: string
- id: string
- eventDateString: string
- ticketCount: number
- vividPerformerId: number
- url: string
- chartUrl: string
- eventDay: string
- eventTypeId: string
- regionId: string
- vividRegionId: number
- minPrice: number
- ageRestriction: number
- maxPrice: number
- secondaryPerformerIds: string[]
- eventDate: number
Example
[
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
eventsForTripRequest: object
Gets an array of events within given parameters.
- endDate: string
- regionId: string
- excludedEvents: string[]
- startDate: string
Example
{
"endDate": "string",
"regionId": "string",
"excludedEvents": [
"string"
],
"startDate": "string"
}
eventsForDateRequest: object
Gets an array of events for a given day in a specific region.
- date: string
- regionId: string
Example
{
"date": "string",
"regionId": "string"
}
continueWithFacebookResponse: object
Successful coninue with Facebook.
- profilePictureUrl: string
- gender: string
- provider: string
- name: string
- id: string
- hasProfilePicture: boolean
- confirmed: boolean
- email: string
- facebookSession: object
Example
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string",
"facebookSession": {
"accessKeyId": "string",
"secretKey": "string",
"sessionToken": "string",
"expiration": "number"
}
}
updatePhoneNumberRequest: object
The facebook id and the updated phone number.
- phoneNumber: string
- id: string
Example
{
"phoneNumber": "string",
"id": "string"
}
resendCodeRequest: object
The facebook id to resend the code for.
- id: string
Example
{
"id": "string"
}
verifyCodeRequest: object
The facebook id and confirmation code
- code: string
- id: string
Example
{
"code": "string",
"id": "string"
}
updatePhoneNumberResponse: object
Returns the updated users phone number.
- phoneNumber: string
- id: string
Example
{
"phoneNumber": "string",
"id": "string"
}
verifyCodeResponse: object
The facebook id and phoneNumber that was confirmed.
- lastName: string
- firstName: string
- krugoId: string
- provider: string
- pushEndpoint: string
- name: string
- id: string
- hasProfilePicture: boolean
- confirmed: boolean
- email: string
- phoneNumberConfirmed: boolean
Example
{
"lastName": "string",
"firstName": "string",
"krugoId": "string",
"provider": "string",
"pushEndpoint": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string",
"phoneNumberConfirmed": "boolean"
}
continueWithFacebookRequest: object
Continue with Facebook
- fbToken: string
Example
{
"fbToken": "string"
}
resendCodeResponse: object
The facebook id and phoneNumber that the new code was sent to.
- deliveryMedium: string
- destination: string
- attributeName: string
Example
{
"deliveryMedium": "string",
"destination": "string",
"attributeName": "string"
}
getImageResponse: object[]
Array of requested images
- md5Hash: string
- size: string
- author: string
- imageUrl: string
- name: string
- rank: number
- id: string
Example
[
{
"md5Hash": "string",
"size": "string",
"author": "string",
"imageUrl": "string",
"name": "string",
"rank": "number",
"id": "string"
}
]
voteImageRequest: object
Upvote or downvote a given image
- md5Hash: string
- id: string
Example
{
"md5Hash": "string",
"id": "string"
}
sendInvitesForCrewResponse: object[]
Returns all the users that were added to the crew.
- firstName: string
- lastName: string
- phoneNumber: string
- isKrugoUser: boolean
- id: string
Example
[
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"isKrugoUser": "boolean",
"id": "string"
}
]
sendInvitesForCrewRequest: object
Invites users to Krugo and adds them to the crew.
- inviterUserId: string
- crewId: string
- newInvites: object[]
- users: object[]
Example
{
"inviterUserId": "string",
"crewId": "string",
"newInvites": [
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"users": [
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"isKrugoUser": "boolean",
"id": "string"
}
]
}
existingMembersResponse: object[]
Returns any existing Krugo members.
- firstName: string
- lastName: string
- phoneNumber: string
- imageUrl: string
- isKrugoUser: boolean
- id: string
Example
[
{
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"imageUrl": "string",
"isKrugoUser": "boolean",
"id": "string"
}
]
unlikeRequest: object
Pushes unliked trip into the unlike trip queue.
- tripId: string
- userId: string
Example
{
"tripId": "string",
"userId": "string"
}
likedTripIdsResponse: object
Returns an array of full liked trips.
- likedTripIds: string[]
Example
{
"likedTripIds": [
"string"
]
}
likedTripsResponse: object[]
Returns an array of liked trips.
- endDate: string
- primaryEventTypeId: string
- tripId: string
- eventCount: number
- lastLikeUnix: number
- cityId: string
- userId: string
- primaryCategoryId: string
- startDate: string
- events: object[]
- likes: number
Example
[
{
"endDate": "string",
"primaryEventTypeId": "string",
"tripId": "string",
"eventCount": "number",
"lastLikeUnix": "number",
"cityId": "string",
"userId": "string",
"primaryCategoryId": "string",
"startDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
],
"likes": "number"
}
]
likeRequest: object
Pushes liked trip into the like trip queue.
- tripId: string
- userId: string
Example
{
"tripId": "string",
"userId": "string"
}
likedTripsRequest: object
Gets liked trips for the given likedTripIds.
- likedTripIds: string[]
Example
{
"likedTripIds": [
"string"
]
}
mailingSettingsResponse: object
Returns the user mailing settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
sendAttachmentEmailResponse: object
Email with attachment sent.
- tmp: string
Example
{
"tmp": "string"
}
sendPlainEmailRequest: object
Send a plain text email from a verified email account.
- cc: string
- bcc: string
- subject: string
- replyTo: string
- from: string
- html: string
- to: string
- text: string
Example
{
"cc": "string",
"bcc": "string",
"subject": "string",
"replyTo": "string",
"from": "string",
"html": "string",
"to": "string",
"text": "string"
}
updateMailingSettingsResponse: object
Returns the updated user mailing settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
joinMailingListResponse: object
Join mailing list status
- status: string
Example
{
"status": "string"
}
updateMailingSettingsRequest: object
Updates the mailing settings for a user.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
joinMailingListRequest: object
Adds a user email to the mailing list for a given domain.
- mailingList: string
- email: string
Example
{
"mailingList": "string",
"email": "string"
}
sendAttachmentEmailRequest: object
Send an email with an attachment from a verified email account.
- cc: string
- s3AttachmentPath: string
- bcc: string
- subject: string
- replyTo: string
- from: string
- html: string
- to: string
- text: string
- s3Bucket: string
Example
{
"cc": "string",
"s3AttachmentPath": "string",
"bcc": "string",
"subject": "string",
"replyTo": "string",
"from": "string",
"html": "string",
"to": "string",
"text": "string",
"s3Bucket": "string"
}
updatePushNotificationSettingsResponse: object
Returns the updated user push notifications settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
updateUserPushEndpointResponse: object
Returns the updated users information.
- pushEndpoint: string
- userId: string
Example
{
"pushEndpoint": "string",
"userId": "string"
}
pushNotificationSettingsResponse: object
Returns the users push notifications settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
updatePushNotificationSettingsRequest: object
Provides a userId and list of updated push notification settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
updateUserPushEndpointRequest: object
Provides a userId and updated pushARN
- userId: string
Example
{
"userId": "string"
}
smsSettingsResponse: object
Returns the user sms notifications settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
updateSmsSettingsResponse: object
Returns the updated user sms notifications settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
updateSmsSettingsRequest: object
Provides a userId and list of updated sms notification settings.
- purchaseIsMade: boolean
- tripBookingReminders: boolean
- crewInvites: boolean
- tripIsShared: boolean
- tripIsMovedToBooking: boolean
- userId: string
Example
{
"purchaseIsMade": "boolean",
"tripBookingReminders": "boolean",
"crewInvites": "boolean",
"tripIsShared": "boolean",
"tripIsMovedToBooking": "boolean",
"userId": "string"
}
updatedTicketsResponse: object
Returns the ticketCount and minimumTicketPrice.
- ticketCount: number
- listingCount: number
- minPrice: number
- maxPrice: number
Example
{
"ticketCount": "number",
"listingCount": "number",
"minPrice": "number",
"maxPrice": "number"
}
trendingPerformersResponse: object[]
Returns an array of trending performers.
- vividId: number
- isParking: boolean
- searchCount: number
- secondaryCategoryId: string
- eventCount: number
- eventType: string
- priority: number
- cmsPath: string
- url: string
- eventTypeId: string
- name: string
- id: string
- vividCategoryId: number
- primaryCategoryId: string
- nextEventDate: number
- slug: string
Example
[
{
"vividId": "number",
"isParking": "boolean",
"searchCount": "number",
"secondaryCategoryId": "string",
"eventCount": "number",
"eventType": "string",
"priority": "number",
"cmsPath": "string",
"url": "string",
"eventTypeId": "string",
"name": "string",
"id": "string",
"vividCategoryId": "number",
"primaryCategoryId": "string",
"nextEventDate": "number",
"slug": "string"
}
]
addTrendingEventRequest: object
A trending event to add.
- discoverQuery: object
- action: string
- type: string
Example
{
"discoverQuery": {},
"action": "string",
"type": "string"
}
addTrendingEventResponse: object
Returns the trendingEvent id, which should be used as the image name.
- id: string
Example
{
"id": "string"
}
getTrendingEventsResponse: object
Returns an array of trending events.
- exclusiveStartTrendingKey: object
- exclusiveStartTopLikedKey: object
- trendingEvents: object[]
Example
{
"exclusiveStartTrendingKey": {
"dateCreated": "number",
"id": "string"
},
"exclusiveStartTopLikedKey": {
"primaryEventTypeId": "string",
"lastLikeUnix": "number",
"tripId": "string"
},
"trendingEvents": [
{
"backgroundColor": "string",
"icon": "string",
"type": "string",
"performerId": "string",
"discoverQuery": {
"performers": [
"string"
],
"regions": [
"string"
],
"cities": [
"string"
],
"endDate": "string",
"venues": [
"string"
],
"categories": [
"string"
],
"startDate": "string"
},
"dateCreated": "number",
"trip": {
"tripStartDate": "string",
"regionId": "string",
"flexibleStartDate": "string",
"timezone": "string",
"flexibleEndDate": "string",
"eventCount": "number",
"tripEndDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
},
"imageUrl": "string",
"action": "string",
"text": "string",
"id": "string",
"discoverQueryType": "string",
"fontColor": "string",
"categoryId": "string"
}
]
}
trendingCitiesResponse: object[]
Returns an array of trending cities.
- lng: number
- city: string
- regionId: string
- countryCode: string
- vividRegionId: number
- timezone: string
- searchCount: number
- id: string
- state: string
- lat: number
Example
[
{
"lng": "number",
"city": "string",
"regionId": "string",
"countryCode": "string",
"vividRegionId": "number",
"timezone": "string",
"searchCount": "number",
"id": "string",
"state": "string",
"lat": "number"
}
]
likeTripIdeaRequest: object
The trip idea to be liked.
- crewId: string
- id: string
- userId: string
Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
addTripIdeaRequest: object
The trip idea and the user suggesting it.
- endDate: string
- crewId: string
- likedUserIds: string[]
- suggestorId: string
- cityId: string
- eventIds: string[]
- startDate: string
Example
{
"endDate": "string",
"crewId": "string",
"likedUserIds": [
"string"
],
"suggestorId": "string",
"cityId": "string",
"eventIds": [
"string"
],
"startDate": "string"
}
addTripIdeaResponse: object
Returns the suggested trip idea.
- endDate: string
- startDateUnix: string
- crewId: string
- likedUserIds: string[]
- suggestorId: string
- id: string
- cityId: string
- eventIds: string[]
- startDate: string
Example
{
"endDate": "string",
"startDateUnix": "string",
"crewId": "string",
"likedUserIds": [
"string"
],
"suggestorId": "string",
"id": "string",
"cityId": "string",
"eventIds": [
"string"
],
"startDate": "string"
}
tripIdeasResponse: object[]
Returns a list of trip ideas for a crew.
- endDate: string
- startDateUnix: number
- crewId: string
- likedUserIds: string[]
- suggestorId: string
- cityId: string
- startDate: string
- events: object[]
Example
[
{
"endDate": "string",
"startDateUnix": "number",
"crewId": "string",
"likedUserIds": [
"string"
],
"suggestorId": "string",
"cityId": "string",
"startDate": "string",
"events": [
{
"listingCount": "number",
"vividId": "number",
"timezone": "string",
"totalPerformerRank": "number",
"searchCount": "number",
"vividVenueId": "number",
"cityId": "string",
"performerId": "string",
"masterPerformer": "boolean",
"venueId": "string",
"eventName": "string",
"id": "string",
"eventDateString": "string",
"ticketCount": "number",
"vividPerformerId": "number",
"url": "string",
"chartUrl": "string",
"eventDay": "string",
"eventTypeId": "string",
"regionId": "string",
"vividRegionId": "number",
"minPrice": "number",
"ageRestriction": "number",
"maxPrice": "number",
"secondaryPerformerIds": [
"string"
],
"eventDate": "number"
}
]
}
]
unlikeTripIdeaRequest: object
The trip idea to be unliked.
- crewId: string
- id: string
- userId: string
Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
likeTripIdeaResponse: object
Returns the liked trip idea.
- crewId: string
- id: string
- userId: string
Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
deleteTripIdeaRequest: object
The trip idea to be deleted.
- crewId: string
- id: string
- userId: string
Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
deleteTripIdeaResponse: object
Returns the deleted trip idea.
- crewId: string
- id: string
Example
{
"crewId": "string",
"id": "string"
}
unlikeTripIdeaResponse: object
Returns the unliked trip idea.
- crewId: string
- id: string
- userId: string
Example
{
"crewId": "string",
"id": "string",
"userId": "string"
}
facebookResponse: object
Successful coninue with Facebook.
- profilePictureUrl: string
- gender: string
- provider: string
- name: string
- id: string
- hasProfilePicture: boolean
- confirmed: boolean
- email: string
- facebookSession: object
Example
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string",
"facebookSession": {
"accessKeyId": "string",
"secretKey": "string",
"sessionToken": "string",
"expiration": "number"
}
}
signupresendRequest: object
If the user didn't receive the signup confirmation code, they may request a new code
- username: string
Example
{
"username": "string"
}
refreshsessionRequest: object
Generate new refreshToken, idToken and accessToken with a new expiry date.
- username: string
- refreshToken: string
Example
{
"username": "string",
"refreshToken": "string"
}
refreshsessionResponse: object
Refresh session success.
- profilePictureUrl: string
- gender: string
- provider: string
- cognitoSession: object
- name: string
- id: string
- hasProfilePicture: boolean
- confirmed: boolean
- email: string
Example
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"cognitoSession": {},
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string"
}
loginmfaRequest: object
Using the information from the login method and the mfaCode received by SMS
- cognitoUsername: string
- mfaCode: string
- loginSession: string
Example
{
"cognitoUsername": "string",
"mfaCode": "string",
"loginSession": "string"
}
updateUserPreferencesRequest: object
Finish the forgot password flow.
- eventTypeSportsEnabled: boolean
- tripLength: number
- tripStartDay: number
- favoriteCategoryIds: string[]
- tripEndDay: number
- tripViewRange: number
- id: string
- favoriteCityIds: string[]
- eventTypeConcertsEnabled: boolean
- eventTypeTheaterEnabled: boolean
- favoritePerformerIds: string[]
Example
{
"eventTypeSportsEnabled": "boolean",
"tripLength": "number",
"tripStartDay": "number",
"favoriteCategoryIds": [
"string"
],
"tripEndDay": "number",
"tripViewRange": "number",
"id": "string",
"favoriteCityIds": [
"string"
],
"eventTypeConcertsEnabled": "boolean",
"eventTypeTheaterEnabled": "boolean",
"favoritePerformerIds": [
"string"
]
}
signupResponse: object
Successful sign up.
- gender: string
- provider: string
- name: string
- id: string
- hasProfilePicture: boolean
- confirmed: boolean
- email: string
Example
{
"gender": "string",
"provider": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string"
}
facebookUpdatePhoneNumberRequest: object
The facebook id and the updated phone number.
- phoneNumber: string
- id: string
Example
{
"phoneNumber": "string",
"id": "string"
}
signupRequest: object
Signup a new user
- password: string
- firstname: string
- attributes: object[]
- username: string
- lastname: string
Example
{
"password": "string",
"firstname": "string",
"attributes": [
{
"Value": "string",
"Name": "string"
}
],
"username": "string",
"lastname": "string"
}
forgotpasswordRequest: object
Start a forgot password flow. Cognito will send a passwordResetCode to one of the user's confirmed contact methods (email or SMS) to be used in the passwordReset method below.
- username: string
Example
{
"username": "string"
}
getUserPreferencesResponse: object
Returns the select users preferences.
- preferredTripLength: number
- homeCity: string
- favoriteEventTypes: string[]
- favoriteCategories: string[]
- userId: string
- favoritePerformers: string[]
- preferredStartDate: string
- preferredEndDate: string
Example
{
"preferredTripLength": "number",
"homeCity": "string",
"favoriteEventTypes": [
"string"
],
"favoriteCategories": [
"string"
],
"userId": "string",
"favoritePerformers": [
"string"
],
"preferredStartDate": "string",
"preferredEndDate": "string"
}
getmfastatusRequest: object
If MFA is enabled for this user, retrieve its options. Otherwise, returns undefined.
- username: string
- refreshToken: string
Example
{
"username": "string",
"refreshToken": "string"
}
changepasswordRequest: object
Use this endpoint to change the user's password.
- oldPassword: string
- newPassword: string
- username: string
- refreshToken: string
Example
{
"oldPassword": "string",
"newPassword": "string",
"username": "string",
"refreshToken": "string"
}
updateUserPreferencesResponse: object
Returns the updated user preferences.
- eventTypeSportsEnabled: boolean
- tripLength: number
- tripStartDay: number
- favoriteCategoryIds: string[]
- tripEndDay: number
- tripViewRange: number
- id: string
- eventTypeConcertsEnabled: boolean
- eventTypeTheaterEnabled: boolean
- favoritePerformerIds: string[]
Example
{
"eventTypeSportsEnabled": "boolean",
"tripLength": "number",
"tripStartDay": "number",
"favoriteCategoryIds": [
"string"
],
"tripEndDay": "number",
"tripViewRange": "number",
"id": "string",
"eventTypeConcertsEnabled": "boolean",
"eventTypeTheaterEnabled": "boolean",
"favoritePerformerIds": [
"string"
]
}
enablemfaResponse: object
Changed MFA status.
- enableMfa: boolean
- username: string
Example
{
"enableMfa": "boolean",
"username": "string"
}
facebookUpdatePhoneNumberResponse: object
Returns the updated users phone number.
- phoneNumber: string
- id: string
Example
{
"phoneNumber": "string",
"id": "string"
}
editphonenumberRequest: object
Use this endpoint to change the user's phone number.
- phoneNumber: string
- id: string
- username: string
- refreshToken: string
Example
{
"phoneNumber": "string",
"id": "string",
"username": "string",
"refreshToken": "string"
}
enablemfaRequest: object
Sets the enablemfa property to true/false.
- enableMfa: boolean
- username: string
- refreshToken: string
Example
{
"enableMfa": "boolean",
"username": "string",
"refreshToken": "string"
}
signupconfirmResponse: object
Account signup confirmed.
- lastName: string
- gender: string
- pushEndpoint: string
- cognitoSession: object
- phonenumber: string
- hasProfilePicture: boolean
- confirmed: boolean
- phoneNumberConfirmed: boolean
- firstName: string
- provider: string
- krugoId: string
- name: string
- id: string
- email: string
Example
{
"lastName": "string",
"gender": "string",
"pushEndpoint": "string",
"cognitoSession": {},
"phonenumber": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"phoneNumberConfirmed": "boolean",
"firstName": "string",
"provider": "string",
"krugoId": "string",
"name": "string",
"id": "string",
"email": "string"
}
loginResponse: object
Login success.
- profilePictureUrl: string
- gender: string
- provider: string
- cognitoSession: object
- phonenumber: string
- name: string
- id: string
- hasProfilePicture: boolean
- confirmed: boolean
- email: string
Example
{
"profilePictureUrl": "string",
"gender": "string",
"provider": "string",
"cognitoSession": {},
"phonenumber": "string",
"name": "string",
"id": "string",
"hasProfilePicture": "boolean",
"confirmed": "boolean",
"email": "string"
}
loginRequest: object
Login an existing and confirmed user
- password: string
- username: string
Example
{
"password": "string",
"username": "string"
}
logoutRequest: object
This method invalidates all issued tokens
- username: string
- refreshToken: string
Example
{
"username": "string",
"refreshToken": "string"
}
loginnewpasswordRequest: object
Using the information from the login method
- newPassword: string
- loginSession: string
- username: string
Example
{
"newPassword": "string",
"loginSession": "string",
"username": "string"
}
getProfilePictureResponse: object
Returns the users profile picture.
- profilePictureUrl: string
Example
{
"profilePictureUrl": "string"
}
verifyphonenumberRequest: object
Use this endpoint to verify the user's new phone number.
- code: string
- id: string
- accessToken: string
Example
{
"code": "string",
"id": "string",
"accessToken": "string"
}
editprofileResponse: object
Edited profile.
- provider: string
- id: string
Example
{
"provider": "string",
"id": "string"
}
signupconfirmRequest: object
Depending on your settings, email confirmation may be required.
- confirmationCode: string
- password: string
- username: string
Example
{
"confirmationCode": "string",
"password": "string",
"username": "string"
}
signupresendResponse: object
Sign up code resent.
- Destination: string
- DeliveryMedium: string
- AttributeName: string
Example
{
"Destination": "string",
"DeliveryMedium": "string",
"AttributeName": "string"
}
editphonenumberResponse: object
Edited phone number.
- phoneNumber: string
- id: string
- username: string
Example
{
"phoneNumber": "string",
"id": "string",
"username": "string"
}
loginnewpasswordResponse: object
Login with new password success.
- username: string
Example
{
"username": "string"
}
resetpasswordRequest: object
Finish the forgot password flow.
- newPassword: string
- passwordResetCode: string
- username: string
Example
{
"newPassword": "string",
"passwordResetCode": "string",
"username": "string"
}
editprofileRequest: object
Use this endpoint to edit all user attributes except phone
- updateAttributes: object[]
- username: string
Example
{
"updateAttributes": [
{
"Value": "string",
"Name": "string"
}
],
"username": "string"
}