Event API (v2)

Download OpenAPI description
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 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 } }

Update event custom field responses

Request

Update the response to a custom field question.

Path
eventIdstringrequired

Event ID

Example: 6926658168
Bodyapplication/json
eventCustomFieldResponsesArray of objects(CustomFieldResponse)required

List of custom field responses for an event.

eventCustomFieldResponses[].​customFieldIdstring(uuid)required

The unique identifier for the custom field.

Example: "f49d00fe-1eda-4304-ba79-a980f565281d"
eventCustomFieldResponses[].​responseItemsArray of objects(CustomFieldResponseItem)

Responses selected by the event coordinator.

eventCustomFieldResponses[].​travelerAccessstring(CustomFieldTravelerAccess)required

Traveler access for the given custom field.

Enum"HIDDEN""READ_ACCESS""WRITE_ACCESS"
curl -i -X PUT \
  https://apis.spotnana.com/v2/events/6926658168/custom-field-responses \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "eventCustomFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ]
  }'

Responses

OK

Response
No content

Bulk publish events

Request

API to bulk publish events and has a support for sending invite to selective users

Bodyapplication/jsonrequired
publishEventListArray of objects(PublishEventRequest)[ 1 .. 1000 ] itemsrequired

List of events to be published.

publishEventList[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
publishEventList[].​sendInvitebooleanrequired

Flag to indicate if an invite should be sent.

Example: true
publishEventList[].​userIdsArray of objects(UserId)[ 0 .. 1000 ] items

List of users receiving the invite. - If provided, invites will be sent only to the specified users. - If empty or not provided, invites will be sent to all users.

publishEventList[].​typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
curl -i -X POST \
  https://apis.spotnana.com/v2/events/bulk-publish \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "publishEventList": [
      {
        "id": "56789012",
        "sendInvite": true,
        "userIds": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        ],
        "type": "GENERIC"
      }
    ]
  }'

Responses

Bulk publish response with event statuses

Bodyapplication/json
publishEventResponsesArray of objects(PublishEventResponse)required

List of events publish response.

publishEventResponses[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
publishEventResponses[].​statusstring(OperationStatus)required

Generic operation/execution status.

Enum"SUCCESS""FAILED""PARTIAL_SUCCESS"
publishEventResponses[].​messagestring

Details about success or failure reason.

Example: "Published successfully"
Response
application/json
{ "publishEventResponses": [ {} ] }