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

Send invite

Request

Send event invites to the travelers via email. The invites can be sent to all travelers using a single API call, or you can send invites to specific travelers.

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)
curl -i -X POST \
  https://apis.spotnana.com/v2/events/6926658168/invite/send \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "GENERIC",
    "userIds": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

OK

Response
No content

Send a test invite

Request

Send a test event invite to the API caller. This endpoint can be used to preview the invite before sending it to the travelers.

Path
eventIdstringrequired

Event ID

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

Responses

OK

Response
No content

Get event summaries

Request

View summaries of specific events. This endpoint retrieves a list of traveler event summaries based on specified userId, companyId, and tripIds.

Bodyapplication/jsonrequired
userIdobject(UserId)

User id

companyIdobject(CompanyId)

Company id

tripIdsArray of strings

List of Spotnana trip IDs

Example: ["6926658168"]
curl -i -X POST \
  https://apis.spotnana.com/v2/events/summaries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "companyId": {
      "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
    },
    "tripIds": [
      "6926658168"
    ]
  }'

Responses

OK

Bodyapplication/json
tripEventSummariesArray of objects(TripEventSummary)

List of Event summaries for trips

Response
application/json
{ "tripEventSummaries": [ {} ] }