How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Spotnana Users API

APIs to onboard and manage users.

Spotnana Users API is one of 33 APIs that Spotnana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 26 operations across 15 paths, and defines 134 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://api-ext-sboxmeta.partners.spotnana.com.

26 operations 15 paths 134 schemas 2 DELETE12 GET4 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://apis.spotnana.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Spotnana Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer). By default, every request must be authenticated.

Paths & Operations 26

Across 15 paths, the API surfaces 26 operations — 2 DELETE, 12 GET, 4 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 26

APIs to onboard and manage users.

POST
/v2/users
Create user
createUser body → 201401403
GET
/v2/users
Query user
queryUser 6 params → 200401403
POST
/v3/users/list
List users
listUsersV3 body → 200401403404
GET
/v2/users/{userId}
Get user
getUserInfo 2 params → 200401403404
DELETE
/v2/users/{userId}
Delete user
deleteUser 1 param → 204401403
PUT
/v2/users/{userId}
Update user
updateUser 1 param body → 200401403404
GET
/v2/users/{userId}/business-info
Get user business info
getBusinessInfo 2 params → 200401403404
PUT
/v2/users/{userId}/business-info
Update user business info
updateBusinessInfo 2 params body → 204401403404
GET
/v2/users/{userId}/personal-info
Get user personal info
getPersonalInfo 2 params → 200401403404
PUT
/v2/users/{userId}/personal-info
Update user personal info
updatePersonalInfo 2 params body → 200401403404
GET
/v2/users/{userId}/travel-preferences
Get user travel preferences
getUserTravelPreferences 1 param → 200401403404
PUT
/v2/users/{userId}/travel-preferences
Update user travel preferences
updateTravelPreferences 1 param body → 204401403404
GET
/v2/users/{userId}/membership-info
Get user membership info
getMembershipInfo 1 param → 200401403404
PUT
/v2/users/{userId}/membership-info
Update user membership info
updateMembershipInfo 1 param body → 204401403404
PUT
/v2/users/{userId}/roles
Update user roles
updateUserRoles 1 param body → 204401403404
GET
/v2/users/{userId}/roles
Get user roles
getUserRoles 1 param → 200401403404
GET
/v2/users/{userId}/notification-preferences
Get notification preferences
getNotificationPreferences 1 param → 200401403404
PUT
/v2/users/{userId}/notification-preferences
Update notification preferences
updateNotificationPreferences 1 param body → 200401403404
GET
/v2/users/{userId}/travel-arrangers
Get user travel arrangers
getUserTravelArrangers 1 param → 200401403404
GET
/v2/users/{userId}/external-id
Get user's external ID
getExternalId 2 params → 200401403404
PUT
/v2/users/{userId}/external-id
Update user's external ID
updateExternalId 2 params body → 200401403404
POST
/v2/users/{userId}/activate
Activate a user
activateUser 1 param → 200401403404
POST
/v2/users/{userId}/favorites
Add favorite
addFavorite 1 param body → 200401403
GET
/v2/users/{userId}/favorites
List favorites
listFavorites 3 params → 200401403
DELETE
/v2/users/{userId}/favorites/{favoriteId}
Remove favorite
removeFavorite 2 params → 200401403404
GET
/v2/users/{userId}/applicable-policies
Get user policies
getUserApplicablePolicies 1 param → 200401403404

Schemas 134

The contract defines 134 schemas that model the data the API accepts and returns. The most detailed are PostalAddress (19 properties), UserProfile (17 properties), BusinessInfo (17 properties), UserPersonalInfo (15 properties). Each schema is shown below with its type and property counts.

UserCreateRequest
object
Traveler details.
14 properties 1 required
BusinessDetail
object
Business details of the user
7 properties 1 required
NationalDocWrapper
object
1 property
NameSuffix
string
Suffix for name
SecondaryServiceProviderTmc
object
Secondary service provider TMC info
3 properties 3 required
SeatPref
object
Preference about seat of rail.
5 properties
UserPersonalInfo
object
User details.
15 properties
TmcInfo
object
TMC config information.
4 properties 2 required
NotificationPreferences
object
Notification preferences of a user for different notification types.
1 property
AddFavoriteResponse
object
Response after adding a favorite item.
1 property
MembershipInfo
object
User's loyalty program membership details.
2 properties
CarPref
object
Travel preferences related to car.
5 properties
RoomPreference
object
Room options and stay preference.
7 properties
PreferredLocationLabel
string
The label of preferred airport or rail station.
PreferredRailStation
object
Rail station preferred by traveler.
5 properties 2 required
ErrorResponse
object
2 properties
Persona
string
Persona of the user
PolicyBasicInfo
object
2 properties 2 required
TmcRoleInfo
object
2 properties 2 required
EngineType
string
Engine types.
AdhocUserInfo
object
Basic information related to ad-hoc traveler profile.
2 properties 1 required
Tier
string
Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP.
ResolvedFavorite
object
A favorite item with its URL.
3 properties
Duration
object
Represents a duration of time with specific units of time.
1 property
TmcBasicInfo
object
TMC related basic information.
2 properties 2 required
DeckLevel
string
The deck level of the rail.
ListUsersV3TmcId
object
TMC ID
1 property 1 required
RailCard
object
Rail card
5 properties 3 required
MealPref
object
Meal preferences.
3 properties
Relation
string
TravelPref
object
Travel preferences.
6 properties
UserSummaryList
object
2 properties
OffsetBasedPaginationResponseParams
object
Pagination parameters for response.
1 property 1 required
PersonalDetail
object
Personal details of the user
7 properties
PrimaryServiceProviderTmc
object
Primary service provider TMC info
1 property 1 required
AddFavoriteRequest
object
Request to add a favorite item for a user.
3 properties 2 required
RailTravelClass
string
Travel class
UserApplicablePolicies
object
Applicable policies for users.
1 property
UserOrgId
object
User and user's organization information.
5 properties 2 required
HotelPrefAmenity
string
Preferred hotel amenity.
TravelArrangerBasicInfo
object
Traveler arranger information.
5 properties 1 required
Reference
object
Reference of an entity
2 properties 1 required
RedressNumber
object
Redress details
2 properties 2 required
TravelerArrangerStatus
string
Status of the traveler-arranger assignment.
DateTimeLocal
object
Local date and time in ISO 8601 format.
1 property 1 required
AirlinePref
object
Airline preferences.
2 properties
TransmissionSearchFilter
string
Transmission type for Filters
TravelerConfigForArranger
object
3 properties
HotelChain
object
The chain of hotel.
2 properties
OrganizationId
object
Organization id for traveler.
1 property 1 required
OffsetBasedPaginationRequestParams
object
Pagination parameters for requests.
2 properties
ImmigrationDocumentWrapper
object
1 property
ExternalIdObject
object
User's external id within partner database.
1 property 1 required
OrganizationAgencyId
object
Agency id for the organization.
1 property 1 required
ImmigrationDocument
object
Immigration document details.
8 properties 3 required
NationalDoc
object
National Document Id details.
5 properties 2 required
RoleMeta
object
1 property
BusinessInfo
object
User business information.
17 properties 2 required
RoleType
string
ListUsersV3CompanyId
object
Company ID
1 property 1 required
Dimensions
object
Image dimensions ie width and height.
2 properties
StealthType
string
Stealth type.
SeatPrefDirection
string
The direction of seat of the rail.
TravelType
string
Travel Type
EntityId
object
Identifier of an object
1 property 1 required
EmergencyContactInfo
object
Emergency contact information.
6 properties 1 required
UserProfile
object
Traveler details.
17 properties
CarType
string
Car type.
Gender
string
FavoriteItem
object
A single favorite item.
5 properties
KnownTravelerNumber
object
Information about the Known Traveler Number (KTN).
2 properties 2 required
CompanySpecifiedAttribute
object
Company specified user arbitrary attribute.
2 properties 2 required
UserSort
object
2 properties 2 required
Passport
object
Passport details.
6 properties 4 required
WorkerType
string
The type of worker.
UserSummary
object
Reference object containing uuid and name and other identifiers.
5 properties 1 required
ListFavoritesResponse
object
Response containing a list of resolved favorites.
1 property
SeatAmenityPref
object
Seat amenity preference.
1 property 1 required
SeatPrefLocation
string
The location of seat of the rail.
UserTravelArrangers
object
Travel arrangers for a user.
1 property 1 required
AlliancePref
object
Alliance preferences.
1 property 1 required
ListUsersV3Response
object
List users response
2 properties
NotificationEmailPreference
object
Email preference for notification type.
2 properties
LoyaltyInfo
object
Loyalty Info details.
6 properties 3 required
DateModel
object
Date in ISO 8601 standard.
1 property 1 required
RoleTypeEnum
string
LoyaltyTier
string
Loyalty membership tier name echoed from the supplier.
SupplierType
string
Supplier type like Sabre, TravelFusion etc.
ErrorParameter
object
Error parameter
2 properties
NumStopsPref
object
Preferred number of stops.
1 property 1 required
TravelArrangerMetadataV2
object
2 properties 2 required
ConditionalRate
string
Conditional rate.
UserId
object
User identifier
1 property 1 required
KnownTravelerNumberWrapper
object
1 property
PreferredPronoun
string
RoleConfig
object
Role Info
3 properties
ListUsersV3Request
object
List users request
6 properties 1 required
RailPref
object
Travel preferences related to rail station.
5 properties
EmergencyContact
object
Emergency contact information.
6 properties 2 required
CompanyId
object
Company ID
1 property 1 required
SeatLocationPref
object
Seat location preference.
4 properties
Name
object
Full name containing first, middle, last (family) names, and suffix.
6 properties 2 required
NotificationType
string
CarVendor
object
Car vendor.
3 properties 2 required
AirPref
object
Travel preferences related to air travel.
9 properties
Image
object
An image with meta data. Either the data or url property must be supplied to load the image.
3 properties
UserUpdateRequest
object
Update Traveler details.
12 properties 2 required
HotelPref
object
Travel preferences related to hotel.
5 properties
PhoneNumber
object
Properly formatted phone number.
10 properties
ProfileOwner
object
Basic information about the owner of the ad-hoc user.
1 property 1 required
Latlng
object
Latitude and Longitude for a Location
2 properties 2 required
CompanyRoleInfo
object
3 properties 2 required
TravelArrangerMetadata
object
1 property 1 required
RelativeOf
object
Link to primary traveler
2 properties
RolesConfig
object
User's roles and associated metadata
1 property 1 required
HotelBrand
object
The brand of hotel.
2 properties
IdentityDocument
object
Identity document details. Currently supported documents are passport, immigration document, known traveler number, redress number and national document.
UserTitle
string
FarePref
object
Fare preferences.
1 property 1 required
SeatPrefType
string
The type of seat of the rail.
UserListFilter
object
Filter object for listing users. AND operation is applied between all the filter conditions.
11 properties
TravelPreferences
object
User's travel preferences
1 property
NotificationPreferencePerType
object
Notification preference for a notification type.
2 properties
PostalAddress
object
Postal Address Details
19 properties 2 required
PassportWrapper
object
1 property
RoleMetadataV2
object
Alliance
string
RedressNumberWrapper
object
1 property
UserDetail
object
Details of the user
9 properties 8 required
StealthMode
object
Stealth mode configuration with type and label.
2 properties 2 required
CompanyRef
object
Basic information about a company.
3 properties 1 required
CoachPref
string
The preference of coach.
MealType
string
Type of the meal
PreferredAirport
object
Airport preferred by traveler.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spotnana-users-api-openapi.yml Raw ↑

Other APIs Spotnana publishes across the network.

Spotnana Air API
Spotnana Air Credits API
Spotnana API User API
Spotnana Approval API
Spotnana Authentication API
Spotnana Autocomplete API
Spotnana Companies API
Spotnana Company Enrollment API
Spotnana Company Policies API
Spotnana Company Tier API
Spotnana Cost Centers API
Spotnana Custom Fields API
Where this information came from

This is an independent, third-party profile of Spotnana Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.