Get user

Request

This endpoint gets user details for user ID.

Security

Bearer

Path

userIdstring, (uuid)required

Identifier for user.

Example:4974a66b-7493-4f41-908c-58ba81093947

Query

includeInactiveboolean

Include inactive users in the response.

Default:false

Example:includeInactive=true

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

idstring, (uuid)

Example:"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"

personalInfoobject(UserPersonalInfo)

User details.

businessInfoobject(BusinessInfo)

User business information.

personastring(Persona)

Persona of the user

Enum:"UNKNOWN_PERSONA""EMPLOYEE""GUEST""PERSONAL""RELATIVE""ADHOC"

Example:"EMPLOYEE"

isActiveboolean

Indicates if traveler is active.

Example:true

tierstring(Tier)

Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP. Display names for other tiers are driven by the company tier configuration.

Default:"BASIC"

Enum:"BASIC""SEAT1A""TIER_2""TIER_3""TIER_4""TIER_5""TIER_6""TIER_7""TIER_8""TIER_9"

Example:"SEAT1A"

stealthModeobject(StealthMode)

Stealth mode configuration with type and label.

travelPreferencesobject(TravelPreferences)

User's travel preferences

membershipInfoobject(MembershipInfo)

User's loyalty program membership details.

notificationPreferencesobject(NotificationPreferences)

Notification preferences of a user for different notification types.

travelArrangersobject(UserTravelArrangers)

Travel arrangers for a user.

adhocUserInfoobject(AdhocUserInfo)

Basic information related to ad-hoc traveler profile.

externalIdstring

The partner-assigned user identifier.

contractingTmcRefobject(Reference object containing uuid and name of the entity.)

Contracting TMC for the user.

bookingTmcRefobject(Reference object containing uuid and name of the entity.)

Booking TMC for the user.

stealthTypestring(StealthType)deprecated

Stealth type.

Enum:"STEALTH_TYPE_1""STEALTH_TYPE_2""STEALTH_TYPE_3"

Example:"STEALTH_TYPE_1"

relativeOfobject(RelativeOf)deprecated

Link to primary traveler

Response

{
  "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
  "personalInfo": {
    "addresses": [ … ],
    "dob": { … },
    "email": "example@email.com",
    "emergencyContactInfo": { … },
    "gender": "FEMALE",
    "identityDocs": [ … ],
    "name": { … },
    "phoneNumbers": [ … ],
    "profilePicture": { … },
    "nationality": "Indian",
    "title": "MR",
    "preferredLanguage": "en-US",
    "preferredPronoun": "SHE_HER_HERS",
    "travelerName": { … },
    "emergencyContact": { … }
  },
  "businessInfo": {
    "departmentRef": { … },
    "designation": "MANAGER",
    "email": "user@business.com",
    "employeeId": "101",
    "gradeRef": { … },
    "legalEntityRef": { … },
    "managerRef": { … },
    "officeRef": { … },
    "organizationRef": { … },
    "phoneNumbers": [ … ],
    "costCenterRef": { … },
    "countryCode": "USA",
    "workerType": "EMPLOYEE",
    "accountingCode": "123",
    "companySpecifiedAttributes": [ … ],
    "designatedApproverRefs": [ … ],
    "authorizerEmail": "example@email.com"
  },
  "persona": "EMPLOYEE",
  "isActive": true,
  "tier": "SEAT1A",
  "stealthType": "STEALTH_TYPE_1",
  "stealthMode": {
    "stealthType": "STEALTH_TYPE_1",
    "label": "string"
  },
  "relativeOf": {
    "userRef": { … },
    "relation": "SPOUSE"
  },
  "travelPreferences": {
    "preferences": { … }
  },
  "membershipInfo": {
    "membershipInfos": [ … ],
    "isLoyaltyBlocked": false
  },
  "notificationPreferences": {
    "preferences": [ … ]
  },
  "travelArrangers": {
    "travelArrangers": [ … ]
  },
  "adhocUserInfo": {
    "profileOwner": { … },
    "isSaved": false
  },
  "externalId": "string",
  "contractingTmcRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "bookingTmcRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  }
}