API reference
/
Events
/
Events
/
Cancel event

Event API (v2)

Download OpenAPI description
EventApi.json
EventApi.yaml
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/eventapi/

Events

APIs to create and manage events.

Operations

Get allowed payment sources

Request

Get the payment sources that are associated with the userId of the event coordinator.

Query
userIdstring(uuid)required

ID of the event coordinator

Example: userId=f49d00fe-1eda-4304-ba79-a980f565281d
curl -i -X GET \
  'https://apis.spotnana.com/v2/events/payment-sources?userId=f49d00fe-1eda-4304-ba79-a980f565281d' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
paymentSourcesArray of objects(PaymentSourceInfo)required

List of payment sources

paymentSources[].​idstring(uuid)required

Unique identifier identifying this payment source

Example: "f49d00fe-1eda-4304-ba79-a980f565281d"
paymentSources[].​typestring(PaymentSourceType)

Type of Payment Source

Enum"CARD""VIRTUAL_CARD""REWARDS_PROGRAM""DELAYED_INVOICING""CUSTOM_PAYMENT_METHOD""VENDOR_PROGRAM_PAYMENT""UNUSED_CREDIT""CASH"
paymentSources[].​paymentSourcePaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object)(PaymentSourceDescriptor)required
One of:

Payment source descriptor.

paymentSources[].​paymentSource.​cardDescriptorobject(CardDescriptor)

Descriptor for card payment source.

paymentSources[].​statusstring(PaymentSourceStatus)read-only

Status of the Payment Source.

Enum"ACTIVE""INCOMPLETE"
paymentSources[].​mappingobject(PaymentSourceMapping)Deprecated

Mapping i.e. access level, travel type information etc.

Response
application/json
{
  "paymentSources": [
    { … }
  ]
}

Cancel event

Request

Cancel a published event. After you've canceled the event, it's recommended that you cancel the bookings using the Cancel PNR API.

Path
eventIdstringrequired

Event ID

Example: 6926658168
Query
typestring(EventType)

EventType of the event.

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
Example: type=GENERIC
curl -i -X POST \
  'https://apis.spotnana.com/v2/events/6926658168/cancel?type=GENERIC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Response
No content

Get travelers list

Request

Get a paginated list of travelers for an event, including each traveler's RSVP status, RSVP response, and tripId.

Path
eventIdstringrequired

Event ID

Example: 6926658168
Bodyapplication/json
offsetinteger>= 0

Indicates from where in the list of travelers the server should start.

Default 0
Example: 2
limitinteger[ 0 .. 100 ]

Maximum number of results to be fetched for the query.

Default 10
Example: 2
typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
filtersArray of objects(EventTravelerFilter)

Filters for event travelers

curl -i -X POST \
  https://apis.spotnana.com/v2/events/6926658168/travelers-list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 2,
    "limit": 2,
    "type": "GENERIC",
    "filters": [
      {
        "type": "string",
        "searchTerm": "name"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
travelerEventInfosArray of objects(TravelerEventInfo)

List of user rsvp responses & trip details

userGroupInfoobject(UserGroupInfo)

Details about group's users

paginationParamsobject(OffsetBasedPaginationResponseParams)

Total number of active travelers in the event

Response
application/json
{
  "travelerEventInfos": [
    { … }
  ],
  "userGroupInfo": {
    "userGroupCriteria": [ … ],
    "userIds": [ … ]
  },
  "paginationParams": {
    "totalNumResults": 0
  }
}
Copyright © 2025 Spotnana Technology, Inc.