Skip to content
API reference
/
Events
/
/
Remove travelers from an...

Event API (v2)

Download OpenAPI description
EventApi.json
EventApi.yaml
Languages
Servers
Sandbox URL

https://api-ext-sboxmeta.partners.spotnana.com/

Spotnana mock server

https://developer.spotnana.com/_mock/openapi/eventapi/

Events

APIs to create and manage events.

Operations

Add travelers to an event

Request

Add the list of travelers to be invited to the event.

Security
Bearer
Path
eventIdstringrequired

Event ID

Example: 6926658168
Bodyapplication/json
typestring(EventType)
Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
userIdsArray of objects(UserId)
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168/travelers/add \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "GENERIC",
    "userIds": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
addedUserIdsArray of objects(UserId)
Response
application/json
{
  "addedUserIds": [
    { … }
  ]
}

Remove travelers from an event

Request

Remove travelers from an event. This endpoint allows you to remove up to 10 travelers per API call.

Security
Bearer
Path
eventIdstringrequired

Event ID

Example: 6926658168
Bodyapplication/json
typestring(EventType)
Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
userIdsArray of objects(UserId)[ 1 .. 10 ] items
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168/travelers/remove \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "GENERIC",
    "userIds": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
removedUserIdsArray of objects(UserId)
Response
application/json
{
  "removedUserIds": [
    { … }
  ]
}

List events

Request

List all the events that match the specified criteria in the request.

Security
Bearer
Bodyapplication/json
listEventTypestring

Type of events

Enum"UPCOMING""PAST_OR_COMPLETED""CANCELLED_EVENT"
Example: "UPCOMING"
filtersArray of EventFilter (object)(EventFilter)

List events filters

travelerFiltersArray of EventTravelerFilter (object)(EventTravelerFilter)

Filters for event travelers

listByTravelerEventsboolean

Whether listing travelers or events.

Default false
Example: true
offsetinteger>= 0

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

Default 0
Example: 2
limitinteger<= 100

Maximum number of results to be fetched for the query.

Default 10
Example: 2
sortOptionsArray of objects(SearchEventSortOptions)

Sort options for the list events request.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "listEventType": "UPCOMING",
    "filters": [
      {
        "userFilter": {
          "userId": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        }
      }
    ],
    "travelerFilters": [
      {
        "type": "string",
        "searchTerm": "name"
      }
    ],
    "listByTravelerEvents": true,
    "offset": 2,
    "limit": 2,
    "sortOptions": [
      {
        "sortField": "START_DATE",
        "sortOrder": "DESC"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
eventsArray of objects(Event)

List of events

paginationParamsobject(OffsetBasedPaginationResponseParams)
Response
application/json
{
  "events": [
    { … }
  ],
  "paginationParams": {
    "totalNumResults": 0
  }
}
Copyright © 2025 Spotnana Technology, Inc.