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

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

List users

Request

List users of a specific TMC or a company.

Security
Bearer
Bodyapplication/jsonrequired
One of:

TMC ID

tmcIdobject(EntityId)required

TMC ID

tmcId.​idstring(uuid)required
Example: "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
userStatusFilterstring

Retrieve active, inactive, or all users.

Default "ACTIVE"
Enum"ACTIVE""INACTIVE""ALL"
Example: "INACTIVE"
searchTextstring

Query text to search users. The match would be case-insensitive.

Example: "chi"
paginationobject(OffsetBasedPaginationRequestParams)required

Pagination parameters for requests.

pagination.​offsetinteger(int32)>= 0

The starting index in the list from which results are returned. The value must be greater than or equal to 0.

Default 0
pagination.​limitinteger(int32)>= 1

Maximum number of results to be fetched.

Default 100
filtersArray of objects(UserListFilter)

Filters to refine the list of users returned. Users matching with any of the filters would be returned.

sortobject(UserSort)
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/users/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tmcId": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
    },
    "userStatusFilter": "INACTIVE",
    "searchText": "chi",
    "pagination": {
      "offset": 0,
      "limit": 100
    },
    "filters": [
      {
        "legalEntityIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "officeIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "departmentIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "costCenterIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "userIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "emails": [
          "string"
        ],
        "externalIds": [
          "string"
        ],
        "personas": [
          "EMPLOYEE"
        ],
        "roles": [
          "TRAVEL_ARRANGER"
        ],
        "designations": [
          "string"
        ],
        "tiers": [
          "SEAT1A"
        ]
      }
    ],
    "sort": {
      "sortBy": "NAME",
      "sortOrder": "DESCENDING"
    }
  }'

Responses

OK

Bodyapplication/json
usersArray of objects(UserDetail)

Users matching the filters specified in the request.

paginationobject(OffsetBasedPaginationResponseParams)

Pagination parameters for response.

Response
application/json
{
  "users": [
    { … }
  ],
  "pagination": {
    "totalNumResults": 0
  }
}

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

OK

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

Enum"BASIC""SEAT1A"
stealthTypestring(StealthType)

Stealth type.

Enum"STEALTH_TYPE_1""STEALTH_TYPE_2""STEALTH_TYPE_3""STEALTH_TYPE_4""STEALTH_TYPE_5""STEALTH_TYPE_6"
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)

Contracting TMC for the user.

bookingTmcRefobject(Reference)

Booking TMC for the user.

relativeOfobject(RelativeOf)Deprecated

Link to primary traveler

Response
application/json
{
  "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",
  "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"
  }
}

Delete user

Request

This endpoint deletes a user by user ID.

Security
Bearer
Path
userIdstring(uuid)required

Identifier for user.

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

Responses

No Content

Response
No content
Copyright © 2025 Spotnana Technology, Inc.