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

TUI Group User API

The user API from TUI Group — 11 operation(s) for user.

TUI Group User API is one of 113 APIs that TUI Group 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 API documentation.

This API exposes 25 operations across 11 paths, and defines 69 schemas. It is described by OpenAPI 3.2.0, at version 4.8.6.23.

Requests are made against 2 base URLs: https://prod.api.tui/flight/newskies/rest, https://playground.api.tui/flight/newskies/rest.

25 operations 11 paths 69 schemas 3 DELETE10 GET3 PATCH5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.8.6.23
Base URL
https://prod.api.tui/flight/newskies/rest
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

TUI Group User API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (jwt) (JWT). By default, every request must be authenticated.

  • JWT — Paste your JWT token from the token endpoint.

Paths & Operations 25

Across 11 paths, the API surfaces 25 operations — 3 DELETE, 10 GET, 3 PATCH, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

user 25
GET
/api/nsk/v1/userdeprecated
Retrieves the current logged in user.
nsk_v1_user_get → 404200
POST
/api/nsk/v1/user
Creates a user and person (used by anonymous to create non agent logins).
nsk_v1_user_post body → 201
PUT
/api/nsk/v1/userdeprecated
Updates the current logged in user.
nsk_v1_user_put body → 200500
PATCH
/api/nsk/v1/userdeprecated
Patches the current logged in user.
nsk_v1_user_patch body → 200500
GET
/api/nsk/v1/user/bookingsdeprecated
Searches the logged in user booking upcoming and past bookings.
nsk_v1_user_bookings_get 14 params → 404200
GET
/api/nsk/v1/user/bookingsByContactCustomerNumber
Searches for any bookings that have the current user as a contact via their customer number.
nsk_v1_user_bookingsByContactCustomerNumber_get 9 params → 200
GET
/api/nsk/v1/user/bookingsByPassengerdeprecated
Searches the logged in user booking upcoming and past bookings.
nsk_v1_user_bookingsByPassenger_get 2 params → 200
GET
/api/nsk/v1/user/impersonate
Gets the logged in users current session roles state.
nsk_v1_user_impersonate_get → 404200
POST
/api/nsk/v1/user/impersonate
Impersonates a new role for the logged in user.
nsk_v1_user_impersonate_post body → 202
DELETE
/api/nsk/v1/user/impersonate
Resets the logged in users role.
nsk_v1_user_impersonate_delete → 400200
POST
/api/nsk/v3/user/password/change
Changes the logged in user's password.
nsk_v3_user_password_change_post body → 201400
GET
/api/nsk/v1/user/preferences/skySpeedSettingsdeprecated
Retrieves the default SkySpeed settings user preferences of the currently logged in user.
nsk_v1_user_preferences_skySpeedSettings_get → 200404
PUT
/api/nsk/v1/user/preferences/skySpeedSettingsdeprecated
Updates the default SkySpeed settings user preferences of the currently logged in user.
nsk_v1_user_preferences_skySpeedSettings_put body → 200404
GET
/api/nsk/v1/user/rolesdeprecated
Gets all roles from the logged in user.
nsk_v1_user_roles_get → 404200
POST
/api/nsk/v1/user/rolesdeprecated
Creates a new role on the logged in user.
nsk_v1_user_roles_post body → 201
GET
/api/nsk/v1/user/roles/{userRoleKey}deprecated
Gets a specific role from the logged in user.
nsk_v1_user_roles_userRoleKey_get 1 param → 404200
PUT
/api/nsk/v1/user/roles/{userRoleKey}deprecated
Updates a specific role on the logged in user.
nsk_v1_user_roles_userRoleKey_put 1 param body → 200500
PATCH
/api/nsk/v1/user/roles/{userRoleKey}deprecated
Patches a specific role on the logged in user.
nsk_v1_user_roles_userRoleKey_patch 1 param body → 200500
DELETE
/api/nsk/v1/user/roles/{userRoleKey}deprecated
Deletes a specific role on the logged in user.
nsk_v1_user_roles_userRoleKey_delete 1 param → 200
GET
/api/nsk/v1/user/singleSignOnToken
Gets all of the single sign on tokens associated with a specific user.
nsk_v1_user_singleSignOnToken_get → 404200
GET
/api/nsk/v1/user/singleSignOnToken/{providerKey}
Gets a single sign on token associated with a specific user.
nsk_v1_user_singleSignOnToken_providerKey_get 1 param → 404200
POST
/api/nsk/v1/user/singleSignOnToken/{providerKey}
Links the requested token with the logged-in user.
nsk_v1_user_singleSignOnToken_providerKey_post 1 param body → 201
PUT
/api/nsk/v1/user/singleSignOnToken/{providerKey}
Updates an existing token associated with the logged-in user.
nsk_v1_user_singleSignOnToken_providerKey_put 1 param body → 200500
PATCH
/api/nsk/v1/user/singleSignOnToken/{providerKey}
Patches an existing token associated with the logged-in user.
nsk_v1_user_singleSignOnToken_providerKey_patch 1 param body → 200500
DELETE
/api/nsk/v1/user/singleSignOnToken/{providerKey}
Deletes a token associated with the single sign on provider from the logged-in user.
nsk_v1_user_singleSignOnToken_providerKey_delete 1 param → 200

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are User (18 properties), BookingSearchResult (17 properties), PersonCreateRequest (16 properties), PersonTravelDocumentRequest (14 properties). Each schema is shown below with its type and property counts.

TransportationIdentifier
object
Represents the transportation identifier model data.
3 properties 2 required
PersonPhoneNumberRequest
object
Defines the the person phone number.
3 properties 2 required
LegTripResult
object
Model data.
8 properties
UserSetting
object
Defines the agent setting configuration.
6 properties
PersonPreferenceCreateRequest
object
Defines a person preference create request.
2 properties
FlightResultFareType
integer
Defines which fares will be included in the flight results. 0 = All 1 = Monetary 2 = Loyalty
LiftStatus
integer
Lift status enumeration. 0 = Default 1 = CheckedIn 2 = Boarded 3 = NoShow
IJsonResponseOfIListOfUserRole
object
Defines the JSON response contract.
3 properties
TransportationDesignator
object
Model information about the traveling arrival and destination details.
4 properties
PersonStatus
integer
The status of the person. 0 = Active 1 = Terminated 2 = Suspended
PersonCustomerProgramCreateRequest
object
Defines a person's customer program create request.
6 properties 2 required
UserCustomerCreateRequest
object
Defines the user customer create request that will be setup with the defined default customer creation parameters.
4 properties 3 required
PersonCommentRequest
object
Defines a person comment request.
2 properties
BookingStatus
integer
Booking Status Enumeration 0 = Default 1 = Hold 2 = Confirmed 3 = Closed 4 = HoldCanceled 5 = PendingArchive 6 = Archived 7 = ArchivedPrivate 777 = ProcessedFo…
Exception
object
4 properties
PersonAliasRequest
object
Defines the person alias request.
6 properties
NskRoles
object
Defines the NSK role.
3 properties
CollectionCurrencySetting
integer
Defines to which the collection currency will be applied. 0 = None 1 = Payments 2 = Fees 3 = Both
UserRole
object
Defines a user role.
7 properties 2 required
MessageStatus
integer
Defines the message status. 0 = General 1 = Warning 2 = Critical
PersonCommentType
integer
Defines the different types of person comments. 0 = Default 1 = Itinerary 2 = Manifest 3 = Alert 4 = Archive 5 = Voucher
User
object
Defines a unique user.
18 properties 3 required
Gender
integer
Defines the different binary gender types. 0 = XX 1 = Male 2 = Female
DeltaMapperOfSingleSignOnTokenRequest
object
Map delta changes of a specific type T to another object.
2 properties
IJsonResponseOfIListOfUserSingleSignOnToken
object
Defines the JSON response contract.
3 properties
PersonTravelDocumentRequest
object
Defines the person travel document.
14 properties 1 required
Name
object
Defines a common name.
5 properties
IJsonResponseOfNskRoles
object
Defines the JSON response contract.
3 properties
UserRequest
object
Defines the user request.
9 properties 2 required
DeltaMapperOfUserRequest
object
Map delta changes of a specific type T to another object.
9 properties
PersonType
integer
Defines the type of person. 0 = None 1 = Customer 2 = Agent
RoleBase
object
Defines the base role.
2 properties
IJsonResponseOfUserRole
object
Defines the JSON response contract.
3 properties
EmailCreateRequest
object
Defines the person email create address.
3 properties 2 required
PersonAffiliation
object
Defines the person affiliation.
2 properties 1 required
LegStatus
integer
Leg status enumeration. 0 = Normal 1 = Closed 2 = Canceled 3 = Suspended 5 = ClosedPending 6 = BlockAllActivities 7 = Mishap
SkySpeedSettingsUserPreferences
object
Defines the SkySpeed default settings for the currently logged in user.
7 properties
DeltaMapperOfUserRolePatchRequest
object
Map delta changes of a specific type T to another object.
2 properties
UserImpersonateRequest
object
Defines a user impersonate request.
1 property 1 required
IJsonResponseOfUser
object
Defines the JSON response contract.
3 properties
IJsonResponseOfSkySpeedSettingsUserPreferences
object
Defines the JSON response contract.
3 properties
PhoneNumberType
integer
Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts. 0 = Other 1 = Home 2 = Work 3 = Mobile 4 = Fax
PriceStatus
integer
Describes the fare pricing status 0 = Invalid 1 = Override 2 = Valid
PaymentMethodType
integer
Defines the payment method types. 0 = ExternalAccount 1 = PrePaid 2 = AgencyAccount 3 = CustomerAccount 4 = Voucher 5 = Loyalty
PersonStoredPaymentRequest
object
Defines the person's stored payment create request.
6 properties 3 required
PersonBasicInformation
object
Defines the person's basic information.
9 properties
SegmentTripResult
object
Model data.
8 properties
ErrorResponse
object
Defines a unique error response.
8 properties
UserRoleCreateRequest
object
Defines the user role create request.
4 properties 2 required
UserChangePasswordRequestv2
object
Defines a user change password request.
2 properties 2 required
IJsonResponseOfUserSingleSignOnToken
object
Defines the JSON response contract.
3 properties
Message
object
Defines a unique informational message.
5 properties
IJsonResponseOfIListOfBookingSearchResult
object
Defines the JSON response contract.
3 properties
NotificationPreference
integer
Describes types of notifications the user would prefer. 0 = None 1 = Promotional
PersonCreateRequest
object
Defines the person create request.
16 properties 1 required
UserSingleSignOnToken
object
Defines a user's single sign on token.
3 properties 1 required
BookingSearchResult
object
Booking model data.
17 properties
UserCodes
object
Defines all the different user codes.
6 properties 4 required
ChannelType
integer
Defines the available channel types doing invoking the communication with the server. 0 = Default 1 = Direct 2 = Web 3 = Gds 4 = Api 5 = DigitalApi 6 = Digital…
UserStatus
integer
Defines the status of a user. 0 = Default 1 = Active 2 = Pending 3 = Suspended 4 = Terminated
BookingTripResult
object
Booking flight result data.
9 properties
UserRoleEditRequest
object
Defines the user role edit request.
3 properties 1 required
IJsonResponse
object
Defines the JSON response contract for a not content type response.
3 properties
DayOfWeek
integer
Defines the day of the week with none as an option. 0 = None 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday
SingleSignOnTokenRequest
object
Defines the single sign on token request.
2 properties 1 required
PaidStatus
integer
Paid status enumeration. 0 = UnderPaid 1 = PaidInFull 2 = OverPaid
IJsonResponseOfIListOfBookingTripResult
object
Defines the JSON response contract.
3 properties
PersonAddressCreateRequest
object
Defines a person address request.
9 properties 1 required
PersonAliasType
integer
Defines the type of alternate name. 0 = Alias 1 = Variant

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tui-group-user-api-openapi.yml Raw ↑

Other APIs TUI Group publishes across the network.

TUI Group Account API
TUI Group Airline Profile API
TUI Group Air Shopping API
TUI Group APIS Message API
TUI Group Apo API
TUI Group Auth API
TUI Group Availability API
TUI Group Baggage API
TUI Group Bag Tag API
TUI Group Boarding API
TUI Group Boarding Devices API
TUI Group Booking/addons API
Where this information came from

This is an independent, third-party profile of TUI Group User 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.