Skip to content
API reference
/
User management
/
/
Get user business info

User Management API (v2)

Download OpenAPI description
UsersApi.json
UsersApi.yaml
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/usersapi

Users

APIs to onboard and manage users.

Operations

Patch user

Request

This endpoint partially updates a user by user ID.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
personalInfoPatchUserPersonalInfo (object) or null
One of:

User details for PATCH requests. All fields are optional and nullable.

businessInfoPatchBusinessInfo (object) or null
One of:

User business information for PATCH requests. All fields are optional and nullable.

personaPersona (string) or null
One of:

Persona of the user

string(Persona)
Enum"UNKNOWN_PERSONA""EMPLOYEE""GUEST""PERSONAL""RELATIVE""ADHOC"
tierTier (string) or null
One of:

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.

string(Tier)
Enum"BASIC""SEAT1A""TIER_2""TIER_3""TIER_4""TIER_5""TIER_6""TIER_7""TIER_8""TIER_9"
stealthTypeStealthType (string) or null
One of:

Stealth type.

string(StealthType)
Enum"STEALTH_TYPE_1""STEALTH_TYPE_2""STEALTH_TYPE_3"
travelPreferencesPatchTravelPreferences (object) or null
One of:

User's travel preferences for PATCH requests. All fields are optional and nullable.

membershipInfoPatchMembershipInfo (object) or null
One of:

User's loyalty program membership details for PATCH requests. All fields are optional and nullable.

notificationPreferencesNotificationPreferences (object) or null
One of:

Notification preferences of a user for different notification types.

adhocUserInfoPatchAdhocUserInfo (object) or null
One of:

Ad-hoc traveler profile info for PATCH requests. All fields are optional.

externalIdstring or null

The partner-assigned user identifier.

curl -i -X PATCH \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "personalInfo": {
      "addresses": [
        {
          "addressLines": [
            "Golden Gate Bridge"
          ],
          "administrativeArea": "CA",
          "administrativeAreaName": "California",
          "description": "San Francisco Home",
          "isDefault": true,
          "languageCode": "en",
          "locality": "San Francisco",
          "locationCode": "LAX",
          "organization": "Spotnana",
          "postalCode": "94130",
          "continentCode": "AF",
          "recipients": [
            "string"
          ],
          "regionCode": "US",
          "regionName": "America",
          "revision": 1,
          "sortingCode": "Jamaica",
          "sublocality": "string",
          "timezone": "America/Los_Angeles",
          "coordinates": {
            "latitude": 77.1025,
            "longitude": 28.7041
          }
        }
      ],
      "dob": {
        "iso8601": "2027-07-21"
      },
      "email": "example@email.com",
      "gender": "FEMALE",
      "identityDocs": [
        {
          "passport": {
            "docId": "PassportID",
            "expiryDate": {
              "iso8601": "2017-07-21"
            },
            "issueCountry": "IN",
            "issuedDate": {
              "iso8601": "2017-07-21"
            },
            "nationalityCountry": "IN",
            "type": "REGULAR"
          }
        }
      ],
      "name": {
        "family1": "Gandas",
        "family2": "FamilyTwo",
        "given": "Vichitr",
        "middle": "Kumar",
        "suffix": "SR",
        "preferred": "Don"
      },
      "phoneNumbers": [
        {
          "countryCode": 91,
          "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
          "extension": "222",
          "isoCountryCode": "IN",
          "italianLeadingZero": true,
          "nationalNumber": 8150,
          "numberOfLeadingZeros": 1,
          "preferredDomesticCarrierCode": "7",
          "rawInput": "77777",
          "type": "MOBILE"
        }
      ],
      "profilePicture": {
        "data": "6935813e12584abda0e43d71cd2ea260",
        "dimensions": {
          "height": 120,
          "width": 240
        },
        "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
      },
      "nationality": "Indian",
      "title": "MR",
      "preferredLanguage": "en-US",
      "preferredPronoun": "SHE_HER_HERS",
      "travelerName": {
        "family1": "Gandas",
        "family2": "FamilyTwo",
        "given": "Vichitr",
        "middle": "Kumar",
        "suffix": "SR",
        "preferred": "Don"
      },
      "emergencyContact": {
        "name": "John Smith",
        "email": "emergency-contact@email.com",
        "relation": "SPOUSE",
        "phoneNumbers": [
          {
            "countryCode": 91,
            "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
            "extension": "222",
            "isoCountryCode": "IN",
            "italianLeadingZero": true,
            "nationalNumber": 8150,
            "numberOfLeadingZeros": 1,
            "preferredDomesticCarrierCode": "7",
            "rawInput": "77777",
            "type": "MOBILE"
          }
        ],
        "preferredLanguage": "en-US"
      }
    },
    "businessInfo": {
      "departmentRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "designation": "MANAGER",
      "email": "user@business.com",
      "employeeId": "101",
      "gradeRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "legalEntityRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "managerRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "officeRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "organizationRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "phoneNumbers": [
        {
          "countryCode": 91,
          "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
          "extension": "222",
          "isoCountryCode": "IN",
          "italianLeadingZero": true,
          "nationalNumber": 8150,
          "numberOfLeadingZeros": 1,
          "preferredDomesticCarrierCode": "7",
          "rawInput": "77777",
          "type": "MOBILE"
        }
      ],
      "costCenterRef": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "countryCode": "USA",
      "workerType": "EMPLOYEE",
      "accountingCode": "123",
      "companySpecifiedAttributes": [
        {
          "fixedColumnName": "contingentType",
          "value": "FSTV"
        }
      ],
      "designatedApproverRefs": [
        {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      ],
      "authorizerEmail": "example@email.com"
    },
    "persona": "EMPLOYEE",
    "tier": "SEAT1A",
    "stealthType": "STEALTH_TYPE_1",
    "travelPreferences": {
      "preferences": {
        "airPref": {
          "airlinePrefs": [
            {
              "airlines": [
                "Indigo"
              ],
              "flightType": "DOMESTIC"
            }
          ],
          "alliancePref": {
            "alliances": [
              "STAR_ALLIANCE"
            ]
          },
          "farePref": {
            "fareTypes": [
              "CHANGEABLE"
            ]
          },
          "homeAirport": "NEW YORK",
          "mealPref": {
            "exclMealPrefs": [
              "VGML"
            ],
            "inclMealPrefs": [
              "VGML"
            ],
            "specialMealDescription": "Veg only meal"
          },
          "numStopPref": {
            "numOfStops": 34
          },
          "seatAmenityPref": {
            "seatAmenityTypes": [
              "WIFI"
            ]
          },
          "seatLocationPrefs": [
            {
              "cabins": [
                "FIRST"
              ],
              "isBulkHeadPref": false,
              "maxFlightDurationInHours": 3,
              "position": "WINDOW"
            }
          ],
          "preferredAirports": [
            {
              "airportName": "San Francisco International Airport",
              "airportCode": "SFO",
              "label": "HOME"
            }
          ]
        },
        "preferredCurrency": "USD",
        "railCards": [
          {
            "cardNumber": "string",
            "expiryDate": {
              "iso8601": "2017-07-21"
            },
            "name": "Veterans Railcard",
            "spotnanaCode": "VET",
            "vendor": "ATOC"
          }
        ],
        "railPref": {
          "preferredRailStations": [
            {
              "stationName": "Chicago Union Station",
              "stationCode": "CHI",
              "cityName": "Chicago",
              "countryCode": "string",
              "label": "HOME"
            }
          ],
          "seatPreference": {
            "hasAccessibility": false,
            "seatTypes": [
              "NORMAL"
            ],
            "seatLocations": [
              "AISLE"
            ],
            "deckLevels": [
              "UPPER_DECK"
            ],
            "seatDirections": [
              "FORWARD"
            ]
          },
          "travelClasses": [
            "FIRST"
          ],
          "coachPreferences": [
            "NON_SMOKING"
          ],
          "conditionalRates": [
            "AAA"
          ]
        },
        "carPref": {
          "vendors": [
            {
              "code": "ZE",
              "name": "HERTZ",
              "isPresentInPreferredVendors": true
            }
          ],
          "carTypes": [
            "ECONOMY"
          ],
          "engineTypes": [
            "PETROL"
          ],
          "transmissionTypes": [
            "AUTOMATIC"
          ],
          "conditionalRates": [
            "AAA"
          ]
        },
        "hotelPref": {
          "hotelParentChains": [
            {
              "chainCode": "EM",
              "chainName": "Mariott"
            }
          ],
          "hotelBrands": [
            {
              "brandCode": "HY",
              "brandName": "Global Hytt Corp."
            }
          ],
          "hotelAmenityTypes": [
            "PARKING"
          ],
          "roomPreference": {
            "isMobilityAccessible": false,
            "bedCount": "ONE_BED",
            "roomType": "SMOKING",
            "mostImportantFact": "BED_COUNT",
            "roomLocation": "HIGH_FLOOR",
            "pillowType": "FOAM",
            "roomAmenityPrefs": [
              "EXTRA_TOWELS"
            ]
          },
          "conditionalRates": [
            "AAA"
          ]
        }
      }
    },
    "membershipInfo": {
      "membershipInfos": [
        {
          "appliedTo": [
            "TAJ"
          ],
          "id": "firstId",
          "issuedBy": "firstIssuedBy",
          "type": "AIR",
          "linked": false,
          "tier": "GOLD"
        }
      ],
      "isLoyaltyBlocked": false
    },
    "notificationPreferences": {
      "preferences": [
        {
          "notificationType": "FLIGHT_NOTIFICATION",
          "emailPreference": {
            "enabled": true,
            "ccEmails": [
              "user@example.com"
            ]
          }
        }
      ]
    },
    "adhocUserInfo": {
      "profileOwner": {
        "userId": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      },
      "isSaved": true
    },
    "externalId": "string"
  }'

Responses

Updated successfully

Response
No content

Get user business info

Request

This endpoint gets user business info by user ID.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

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

Include inactive users.

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

Responses

OK

Bodyapplication/json
departmentRefobject(Reference)

Reference of an entity

designationstring
Example: "MANAGER"
emailstring(email)
Example: "user@business.com"
employeeIdstring

Unique employee id. Can use email if a company don't use employee ids.

Example: "101"
gradeRefobject(Reference)

Reference of an entity

legalEntityRefobject(Reference)required

Reference of an entity

legalEntityRef.​idstring(uuid)required
Example: "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
legalEntityRef.​namestring
Example: "Name"
managerRefobject(Reference)

Reference of an entity

officeRefobject(Reference)

Reference of an entity

organizationRefobject(Reference)required

Reference of an entity

organizationRef.​idstring(uuid)required
Example: "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
organizationRef.​namestring
Example: "Name"
phoneNumbersArray of objects(PhoneNumber)
costCenterRefobject(Reference)

Reference of an entity

countryCodestring

alpha-2 or alpha-3 ISO country code.

Example: "USA"
workerTypestring(WorkerType)

The type of worker.

Enum"EMPLOYEE""CONTINGENT""SEASONAL""INTERN""GUEST"
accountingCodestring

Code used for accounting.

Example: "123"
companySpecifiedAttributesArray of objects(CompanySpecifiedAttribute)
designatedApproverRefsArray of objects(Reference object containing uuid and name of the entity.)

A list of references for designated approvers.

authorizerEmailstring

Email address to be used as approval authorizer, when a manager is not present.

Example: "example@email.com"
Response
application/json
{
  "departmentRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "designation": "MANAGER",
  "email": "user@business.com",
  "employeeId": "101",
  "gradeRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "legalEntityRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "managerRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "officeRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "organizationRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "phoneNumbers": [
    { … }
  ],
  "costCenterRef": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "countryCode": "USA",
  "workerType": "EMPLOYEE",
  "accountingCode": "123",
  "companySpecifiedAttributes": [
    { … }
  ],
  "designatedApproverRefs": [
    { … }
  ],
  "authorizerEmail": "example@email.com"
}

Update user business info

Request

This endpoint updates user business info by user ID.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

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

Include inactive users.

Default false
Example: includeInactive=true
Bodyapplication/jsonrequired
departmentRefobject(Reference)

Reference of an entity

designationstring
Example: "MANAGER"
emailstring(email)
Example: "user@business.com"
employeeIdstring

Unique employee id. Can use email if a company don't use employee ids.

Example: "101"
gradeRefobject(Reference)

Reference of an entity

legalEntityRefobject(Reference)required

Reference of an entity

legalEntityRef.​idstring(uuid)required
Example: "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
legalEntityRef.​namestring
Example: "Name"
managerRefobject(Reference)

Reference of an entity

officeRefobject(Reference)

Reference of an entity

organizationRefobject(Reference)required

Reference of an entity

organizationRef.​idstring(uuid)required
Example: "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
organizationRef.​namestring
Example: "Name"
phoneNumbersArray of objects(PhoneNumber)
costCenterRefobject(Reference)

Reference of an entity

countryCodestring

alpha-2 or alpha-3 ISO country code.

Example: "USA"
workerTypestring(WorkerType)

The type of worker.

Enum"EMPLOYEE""CONTINGENT""SEASONAL""INTERN""GUEST"
accountingCodestring

Code used for accounting.

Example: "123"
companySpecifiedAttributesArray of objects(CompanySpecifiedAttribute)
designatedApproverRefsArray of objects(Reference object containing uuid and name of the entity.)

A list of references for designated approvers.

authorizerEmailstring

Email address to be used as approval authorizer, when a manager is not present.

Example: "example@email.com"
curl -i -X PUT \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/users/4974a66b-7493-4f41-908c-58ba81093947/business-info?includeInactive=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "departmentRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "designation": "MANAGER",
    "email": "user@business.com",
    "employeeId": "101",
    "gradeRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "legalEntityRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "managerRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "officeRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "organizationRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "phoneNumbers": [
      {
        "countryCode": 91,
        "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
        "extension": "222",
        "isoCountryCode": "IN",
        "italianLeadingZero": true,
        "nationalNumber": 8150,
        "numberOfLeadingZeros": 1,
        "preferredDomesticCarrierCode": "7",
        "rawInput": "77777",
        "type": "MOBILE"
      }
    ],
    "costCenterRef": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
      "name": "Name"
    },
    "countryCode": "USA",
    "workerType": "EMPLOYEE",
    "accountingCode": "123",
    "companySpecifiedAttributes": [
      {
        "fixedColumnName": "contingentType",
        "value": "FSTV"
      }
    ],
    "designatedApproverRefs": [
      {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      }
    ],
    "authorizerEmail": "example@email.com"
  }'

Responses

OK

Response
No content

Roles

Operations
Copyright © 2026 Spotnana Technology, Inc.