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 event by external ID

Request

Get event details using the event's externalId. External IDs are unique identifiers which can be set based on the company's preference.

Query
externalIdstringrequired

External ID

Example: externalId=6926658168
companyIdstring(uuid)required

Company ID

Example: companyId=f49d00fe-1eda-4304-ba79-a980f565281d
curl -i -X GET \
  'https://apis.spotnana.com/v2/events/read-by-external-id?companyId=f49d00fe-1eda-4304-ba79-a980f565281d&externalId=6926658168' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
eventobject(Event)

Event details

Response
application/json
{ "event": { "id": "string", "name": "string", "type": "GENERIC", "description": "string", "startDateTime": {}, "endDateTime": {}, "location": {}, "group": {}, "status": "DRAFT", "companyId": {}, "runningStatus": "UPCOMING", "paymentSources": [], "numTravelers": 1, "customFieldResponses": [], "externalId": "qwert123", "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b", "parentEventId": "56789012" } }

Add travelers to an event

Request

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

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/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.

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

OK

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