API reference

Events

Delete a draft event

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

Get event

Request

Get event details for the specified event ID.

Path

eventIdstringrequired

Event ID

Example: 6926658168

Query

typestring(EventType)

EventType of the event.

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

Example: type=GENERIC

curl -i -X GET \
  'https://apis.spotnana.com/v2/events/6926658168?type=GENERIC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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"
  }
}

Delete a draft event

Request

Delete a draft (i.e., unpublished) event. A deleted event cannot be accessed or viewed again.

Path

eventIdstringrequired

Event ID

Example: 6926658168

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

Responses

Response

No content

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

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"
  }
}