API reference

Events

List events

Event API (v2)

Download OpenAPI description

EventApi.json

EventApi.yaml

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

Remove travelers from an event

Request

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

Path

eventIdstringrequired

Event ID

Example: 6926658168

Bodyapplication/json

typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"

userIdsArray of objects(UserId)[ 1 .. 10 ] items

curl -i -X POST \
  https://apis.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

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.

Bodyapplication/json

listEventTypestring

Type of events

Enum"UPCOMING""PAST_OR_COMPLETED""CANCELLED_EVENT"

Example: "UPCOMING"

filtersArray of EventUserFilterWrapper (object) or EventStatusFilterWrapper (object) or EventNameFilterWrapper (object) or EventDateRangeFilterWrapper (object) or EventCompanyFilterWrapper (object) or EventParentFilterWrapper (object) or EventTypeFilterWrapper (object) or EventIdFilterWrapper (object) or EventDetachedFilterWrapper (object)(EventFilter)

List events filters

travelerFiltersArray of objects(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://apis.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

Bodyapplication/json

eventsArray of objects(Event)

List of events

paginationParamsobject(OffsetBasedPaginationResponseParams)

Pagination parameters for response.

Response

application/json

{
  "events": [
    { … }
  ],
  "paginationParams": {
    "totalNumResults": 0
  }
}

Publish event

Request

Publish a draft event.

Path

eventIdstringrequired

Event ID

Example: 6926658168

curl -i -X POST \
  https://apis.spotnana.com/v2/events/6926658168/publish \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

idstring

Example: "some-id"

Response

application/json

{
  "id": "some-id"
}

Event API (v2)

Events

Remove travelers from an event

RequestExpand all

Responses

List events

RequestExpand all

Responses

Publish event

Request

Responses

Request

Request