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 Users API

The users API from TUI Group — 42 operation(s) for users.

TUI Group Users 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 105 operations across 42 paths, and defines 139 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.

105 operations 42 paths 139 schemas 16 DELETE38 GET14 PATCH19 POST18 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 Users 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 105

Across 42 paths, the API surfaces 105 operations — 16 DELETE, 38 GET, 14 PATCH, 19 POST, 18 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 105
POST
/api/nsk/v1/users
Creates a new user and person (used by agents to create other users)
nsk_v1_users_post body → 201400
GET
/api/nsk/v2/users
Search user records
nsk_v2_users_get 12 params → 404200
POST
/api/nsk/v2/users
Creates a new user for a person (used by agents to create other users)
nsk_v2_users_post body → 201400
GET
/api/nsk/v1/users/{userKey}
Retrieves the a specific user
nsk_v1_users_userKey_get 1 param → 404200
PUT
/api/nsk/v1/users/{userKey}
Updates the specific user
nsk_v1_users_userKey_put 1 param body → 200400500
PATCH
/api/nsk/v1/users/{userKey}
Patches the current logged in user
nsk_v1_users_userKey_patch 1 param body → 200400500
DELETE
/api/nsk/v1/users/{userKey}
Delete the user
nsk_v1_users_userKey_delete 1 param → 200
GET
/api/nsk/v1/users/{userKey}/bookings
Searches the specific user for upcoming and past bookings
nsk_v1_users_userKey_bookings_get 15 params → 404200
GET
/api/nsk/v1/users/{userKey}/bookingsByPassenger
Searches the specific user upcoming and past bookings by passenger
nsk_v1_users_userKey_bookingsByPassenger_get 3 params → 200
POST
/api/nsk/v1/users/{userKey}/password/change
Changes a specifics user's password
nsk_v1_users_userKey_password_change_post 1 param body → 201
POST
/api/nsk/v1/users/{userKey}/password/reset
Invokes the forgot password reset for a specific user
nsk_v1_users_userKey_password_reset_post 1 param → 202
GET
/api/nsk/v1/users/{userKey}/person
Retrieves the specific user's person
nsk_v1_users_userKey_person_get 1 param → 404200
PUT
/api/nsk/v1/users/{userKey}/person
Updates the specific user's person record basic information
nsk_v1_users_userKey_person_put 1 param body → 200400401500
PATCH
/api/nsk/v1/users/{userKey}/person
Patches the specific user's person records basic information
nsk_v1_users_userKey_person_patch 1 param body → 200400401500
GET
/api/nsk/v1/users/{userKey}/person/addresses
Gets all addresses from the specific user's person
nsk_v1_users_userKey_person_addresses_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/addresses
Creates a new address on the specific user's person
nsk_v1_users_userKey_person_addresses_post 1 param body → 201
GET
/api/nsk/v1/users/{userKey}/person/addresses/{personAddressKey}
Gets a specific address from the specific user's person
nsk_v1_users_userKey_person_addresses_personAddressKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/addresses/{personAddressKey}
Updates a specific address on the specific user's person
nsk_v1_users_userKey_person_addresses_personAddressKey_put 2 params body → 200500
PATCH
/api/nsk/v1/users/{userKey}/person/addresses/{personAddressKey}
Patches a specific address on the specific user's person
nsk_v1_users_userKey_person_addresses_personAddressKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/person/addresses/{personAddressKey}
Deletes a specific address on the specific user's person
nsk_v1_users_userKey_person_addresses_personAddressKey_delete 2 params → 200
GET
/api/nsk/v1/users/{userKey}/person/affiliations
Gets all affiliations from the specific user's person
nsk_v1_users_userKey_person_affiliations_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/affiliations
Creates a new affiliation for the specific user's person
nsk_v1_users_userKey_person_affiliations_post 1 param body → 201400401
GET
/api/nsk/v1/users/{userKey}/person/affiliations/{personAffiliationKey}
Gets a specific affiliation from the specific user's person
nsk_v1_users_userKey_person_affiliations_personAffiliationKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/affiliations/{personAffiliationKey}
Updates a specific affiliation for the specific user's person
nsk_v1_users_userKey_person_affiliations_personAffiliationKey_put 2 params body → 200400401500
DELETE
/api/nsk/v1/users/{userKey}/person/affiliations/{personAffiliationKey}
Deletes a specific affiliation for the specific user's person
nsk_v1_users_userKey_person_affiliations_personAffiliationKey_delete 2 params → 200400401
GET
/api/nsk/v1/users/{userKey}/person/aliases
Gets all aliases from the specific user's person
nsk_v1_users_userKey_person_aliases_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/aliases
Creates a new alias on the specific user's person
nsk_v1_users_userKey_person_aliases_post 1 param body → 201400401
GET
/api/nsk/v1/users/{userKey}/person/aliases/{personAliasKey}
Gets a specific alias from the specific user's person
nsk_v1_users_userKey_person_aliases_personAliasKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/aliases/{personAliasKey}
Updates a specific alias on the specific user's person
nsk_v1_users_userKey_person_aliases_personAliasKey_put 2 params body → 200400401500
PATCH
/api/nsk/v1/users/{userKey}/person/aliases/{personAliasKey}
Patches a specific alias on the specific user's person
nsk_v1_users_userKey_person_aliases_personAliasKey_patch 2 params body → 200400401500
DELETE
/api/nsk/v1/users/{userKey}/person/aliases/{personAliasKey}
Deletes a specific alias on the specific user's person
nsk_v1_users_userKey_person_aliases_personAliasKey_delete 2 params → 200400401
GET
/api/nsk/v1/users/{userKey}/person/comments
Gets all comments from the specific user's person
nsk_v1_users_userKey_person_comments_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/comments
Creates a new comment on the specific user's person
nsk_v1_users_userKey_person_comments_post 1 param body → 201400401
GET
/api/nsk/v1/users/{userKey}/person/comments/{personCommentKey}
Gets a specific comment from the specific user's person
nsk_v1_users_userKey_person_comments_personCommentKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/comments/{personCommentKey}
Updates a specific comment on the specific user's person
nsk_v1_users_userKey_person_comments_personCommentKey_put 2 params body → 200400401500
PATCH
/api/nsk/v1/users/{userKey}/person/comments/{personCommentKey}
Patches a specific comment on the specific user's person
nsk_v1_users_userKey_person_comments_personCommentKey_patch 2 params body → 200400401500
DELETE
/api/nsk/v1/users/{userKey}/person/comments/{personCommentKey}
Deletes a specific comment on the specific user's person
nsk_v1_users_userKey_person_comments_personCommentKey_delete 2 params → 200400401
GET
/api/nsk/v1/users/{userKey}/person/emails
Gets all email addresses from the specific user's person
nsk_v1_users_userKey_person_emails_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/emails
Creates a new email address on the specific user's person
nsk_v1_users_userKey_person_emails_post 1 param body → 201
GET
/api/nsk/v1/users/{userKey}/person/emails/{personEmailAddressKey}
Gets a specific email address from the specific user's person
nsk_v1_users_userKey_person_emails_personEmailAddressKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/emails/{personEmailAddressKey}
Updates a specific email address on the specific user's person
nsk_v1_users_userKey_person_emails_personEmailAddressKey_put 2 params body → 200500
PATCH
/api/nsk/v1/users/{userKey}/person/emails/{personEmailAddressKey}
Patches a specific email address on the specific user's person
nsk_v1_users_userKey_person_emails_personEmailAddressKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/person/emails/{personEmailAddressKey}
Deletes a specific email address on the specific user's person
nsk_v1_users_userKey_person_emails_personEmailAddressKey_delete 2 params → 200
GET
/api/nsk/v1/users/{userKey}/person/information
Gets all information for a specific user's person
nsk_v1_users_userKey_person_information_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/information
Creates new information for a specific user's person
nsk_v1_users_userKey_person_information_post 1 param body → 201400
GET
/api/nsk/v1/users/{userKey}/person/information/{personInformationKey}
Gets specific information for a specific user's person
nsk_v1_users_userKey_person_information_personInformationKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/information/{personInformationKey}
Updates specific information for a specific user's person
nsk_v1_users_userKey_person_information_personInformationKey_put 2 params body → 200400500
PATCH
/api/nsk/v1/users/{userKey}/person/information/{personInformationKey}
Patches specific information for a specific user's person
nsk_v1_users_userKey_person_information_personInformationKey_patch 2 params body → 200400500
DELETE
/api/nsk/v1/users/{userKey}/person/information/{personInformationKey}
Deletes specific information for a specific user's person
nsk_v1_users_userKey_person_information_personInformationKey_delete 2 params → 200
GET
/api/nsk/v1/users/{userKey}/person/phoneNumbers
Gets all phone numbers from the specific user's person
nsk_v1_users_userKey_person_phoneNumbers_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/phoneNumbers
Creates a new phone number on the specific user's person
nsk_v1_users_userKey_person_phoneNumbers_post 1 param body → 201
GET
/api/nsk/v1/users/{userKey}/person/phoneNumbers/{personPhoneNumberKey}
Gets a specific phone number from the specific user's person
nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/phoneNumbers/{personPhoneNumberKey}
Updates a specific phone number on the specific user's person
nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_put 2 params body → 200500
PATCH
/api/nsk/v1/users/{userKey}/person/phoneNumbers/{personPhoneNumberKey}
Patches a specific phone number on the specific user's person
nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/person/phoneNumbers/{personPhoneNumberKey}
Deletes a specific phone number on the specific user's person
nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_delete 2 params → 200
GET
/api/nsk/v1/users/{userKey}/person/preferences
Gets all preferences for a specific user's person
nsk_v1_users_userKey_person_preferences_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/preferences
Creates a new preference for a specific user's person
nsk_v1_users_userKey_person_preferences_post 1 param body → 201
GET
/api/nsk/v1/users/{userKey}/person/preferences/{personPreferenceKey}
Gets a specific preference for a specific user's person
nsk_v1_users_userKey_person_preferences_personPreferenceKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/preferences/{personPreferenceKey}
Updates a specific preference for a specific user's person
nsk_v1_users_userKey_person_preferences_personPreferenceKey_put 2 params body → 200500
PATCH
/api/nsk/v1/users/{userKey}/person/preferences/{personPreferenceKey}
Patches a specific preference for a specific user's person
nsk_v1_users_userKey_person_preferences_personPreferenceKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/person/preferences/{personPreferenceKey}
Deletes a specific preference for a specific user's person
nsk_v1_users_userKey_person_preferences_personPreferenceKey_delete 2 params → 200
GET
/api/nsk/v1/users/{userKey}/person/programs
Gets all programs from the specific user's person
nsk_v1_users_userKey_person_programs_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/programs
Creates a new program on the specific user's person
nsk_v1_users_userKey_person_programs_post 1 param body → 201400401
GET
/api/nsk/v1/users/{userKey}/person/programs/{personProgramKey}
Gets a specific program from the specific user's person
nsk_v1_users_userKey_person_programs_personProgramKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/programs/{personProgramKey}
Updates a specific program on the specific user's person
nsk_v1_users_userKey_person_programs_personProgramKey_put 2 params body → 200400401500
PATCH
/api/nsk/v1/users/{userKey}/person/programs/{personProgramKey}
Patches a specific program on the specific user's person
nsk_v1_users_userKey_person_programs_personProgramKey_patch 2 params body → 200400401500
DELETE
/api/nsk/v1/users/{userKey}/person/programs/{personProgramKey}
Deletes a specific program on the specific user's person
nsk_v1_users_userKey_person_programs_personProgramKey_delete 2 params → 200400401
GET
/api/nsk/v1/users/{userKey}/person/storedPayments
Gets all stored payments from the specific user's person
nsk_v1_users_userKey_person_storedPayments_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/storedPayments
Creates a new stored payment on the specific user's person
nsk_v1_users_userKey_person_storedPayments_post 1 param body → 201
GET
/api/nsk/v1/users/{userKey}/person/storedPayments/{personStoredPaymentKey}
Gets a specific stored payment from the specific user's person
nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/storedPayments/{personStoredPaymentKey}
Updates a specific stored payment on the specific user's person
nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_put 2 params body → 200500
PATCH
/api/nsk/v1/users/{userKey}/person/storedPayments/{personStoredPaymentKey}
Patches a specific stored payment on the specific user's person
nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/person/storedPayments/{personStoredPaymentKey}
Deletes a specific stored payment on the specific user's person
nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_delete 2 params → 200
GET
/api/nsk/v1/users/{userKey}/person/travelDocuments
Gets all travel documents from the specific user's person
nsk_v1_users_userKey_person_travelDocuments_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/travelDocuments
Creates a new travel document on the specific user's person.
nsk_v1_users_userKey_person_travelDocuments_post 1 param body → 201400401
GET
/api/nsk/v1/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}
Gets a specific travel document from the specific user's person
nsk_v1_users_userKey_person_travelDocuments_personTravelDocumentKey_get 2 params → 404200
DELETE
/api/nsk/v1/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}
Deletes a specific travel document on the specific user's person
nsk_v1_users_userKey_person_travelDocuments_personTravelDocumentKey_delete 2 params → 200400401
PUT
/api/nsk/v2/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}
Updates a specific travel document on the specific user's person.
nsk_v2_users_userKey_person_travelDocuments_personTravelDocumentKey_put 2 params body → 200400401500
PATCH
/api/nsk/v2/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}
Patches a specific travel document on the specific user's person.
nsk_v2_users_userKey_person_travelDocuments_personTravelDocumentKey_patch 2 params body → 200400401500
GET
/api/nsk/v1/users/{userKey}/person/travelNotifications
Gets person travel notifications for a user's person
nsk_v1_users_userKey_person_travelNotifications_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/person/travelNotifications
Creates a person travel notification for a user's person
nsk_v1_users_userKey_person_travelNotifications_post 1 param body → 201
GET
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}
Gets a person travel notification for a user's person
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}
Updates a person travel notification for a user's person
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_put 2 params body → 200500
PATCH
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}
Patches a person travel notification for a user's person
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}
Deletes a person travel notification for a user's person
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_delete 2 params → 200
GET
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events
Gets notification events for a person travel notification for a user's person
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_get 2 params → 200404
POST
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events
Creates a notification event for a person travel notification for a user's…
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_post 2 params body → 201
GET
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events/{eventType}
Gets a notification event for a person travel notification for a user's person
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_eventType_get 3 params → 200404
DELETE
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events/{eventType}
Deletes a notification event from a person travel notification for a user's…
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_eventType_delete 3 params → 200
GET
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents
Gets notification timed events for a person travel notification for a user's…
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_get 2 params → 200404
POST
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents
Creates a notification timed event for a person travel notification for a…
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_post 2 params body → 201
GET
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}
Gets a notification timed event for a person travel notification for a user's…
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_get 3 params → 200404
PUT
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}
Updates a notification timed event for a person travel notification for a…
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_put 3 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}
Deletes a notification timed event from a person travel notification for a…
nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_delete 3 params → 200
GET
/api/nsk/v1/users/{userKey}/preferences/skySpeedSettingsdeprecated
Retrieves the default SkySpeed settings user preferences of the specified user
nsk_v1_users_userKey_preferences_skySpeedSettings_get 1 param → 200404
PUT
/api/nsk/v1/users/{userKey}/preferences/skySpeedSettingsdeprecated
Updates the default SkySpeed settings user preferences of the specified user
nsk_v1_users_userKey_preferences_skySpeedSettings_put 1 param body → 200404
GET
/api/nsk/v2/users/{userKey}/preferences/skySpeedSettings
Retrieves the default SkySpeed settings user preferences of the specified user
nsk_v2_users_userKey_preferences_skySpeedSettings_get 1 param → 200404
PUT
/api/nsk/v2/users/{userKey}/preferences/skySpeedSettings
Updates the default SkySpeed settings user preferences of the specified user
nsk_v2_users_userKey_preferences_skySpeedSettings_put 1 param body → 200400
GET
/api/nsk/v1/users/{userKey}/roles
Gets all roles for a specific user
nsk_v1_users_userKey_roles_get 1 param → 404200
POST
/api/nsk/v1/users/{userKey}/roles
Creates a new role for a specific user
nsk_v1_users_userKey_roles_post 1 param body → 201
GET
/api/nsk/v1/users/{userKey}/roles/{userRoleKey}
Gets a specific role for a specific user
nsk_v1_users_userKey_roles_userRoleKey_get 2 params → 404200
PUT
/api/nsk/v1/users/{userKey}/roles/{userRoleKey}
Updates a specific role for a specific user
nsk_v1_users_userKey_roles_userRoleKey_put 2 params body → 200500
PATCH
/api/nsk/v1/users/{userKey}/roles/{userRoleKey}
Patches a specific role for a specific user
nsk_v1_users_userKey_roles_userRoleKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/users/{userKey}/roles/{userRoleKey}
Deletes a specific role for a specific user
nsk_v1_users_userKey_roles_userRoleKey_delete 2 params → 200
GET
/api/nsk/v1/users/byPerson/{personKey}
Retrieves the a specific user by the person key
nsk_v1_users_byPerson_personKey_get 1 param → 404200

Schemas 139

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

UserCodes
object
Defines all the different user codes.
6 properties 4 required
DeltaMapperOfUserRequest
object
Map delta changes of a specific type T to another object.
9 properties
DeltaMapperOfPersonPreferenceEditRequest
object
Map delta changes of a specific type T to another object.
1 property
LegTripResult
object
Model data.
8 properties
NotificationEventType
integer
Represents the type of notification event type for a travel notification event. 0 = DepartureDelay 1 = ArrivalDelay 2 = ScheduleChange 3 = CheckIn 4 = GateInfo…
Exception
object
4 properties
IJsonResponseOfPersonAlias
object
Defines the JSON response contract.
3 properties
BookingStatus
integer
Booking Status Enumeration 0 = Default 1 = Hold 2 = Confirmed 3 = Closed 4 = HoldCanceled 5 = PendingArchive 6 = Archived 7 = ArchivedPrivate 777 = ProcessedFo…
IJsonResponseOfSkySpeedSettingsUserPreferences
object
Defines the JSON response contract.
3 properties
UserRoleEditRequest
object
Defines the user role edit request.
3 properties 1 required
IJsonResponseOfPersonStoredPayment
object
Defines the JSON response contract.
3 properties
PersonPreference
object
Defines the person preferences.
3 properties
PersonCustomerProgramCreateRequest
object
Defines a person's customer program create request.
6 properties 2 required
IJsonResponseOfIListOfPersonPreference
object
Defines the JSON response contract.
3 properties
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…
BookingSearchResult
object
Booking model data.
17 properties
TravelDocumentEditRequestv2
object
Defines the edit travel document request.
12 properties 1 required
PersonAliasRequest
object
Defines the person alias request.
6 properties
PersonName
object
Defines a person name.
6 properties
PersonAlias
object
Defines a person's alternate name that they go by.
7 properties
PersonStoredPaymentRequest
object
Defines the person's stored payment create request.
6 properties 3 required
UserChangePasswordRequestBase
object
Defines a change password request base.
1 property 1 required
UserRoleCreateRequest
object
Defines the user role create request.
4 properties 2 required
LegStatus
integer
Leg status enumeration. 0 = Normal 1 = Closed 2 = Canceled 3 = Suspended 5 = ClosedPending 6 = BlockAllActivities 7 = Mishap
IJsonResponseOfIListOfPersonStoredPayment
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonComment
object
Defines the JSON response contract.
3 properties
PersonPreferenceCreateRequest
object
Defines a person preference create request.
2 properties
DeliveryMethodCode
integer
Represents the delivery method codes. 0 = Email 1 = Sms 2 = Push
IJsonResponseOfPersonCustomerProgram
object
Defines the JSON response contract.
3 properties
PersonInformationCreateRequest
object
Defines a person information create request.
2 properties 1 required
PersonInformation
object
Defines the a person information.
4 properties 1 required
IJsonResponseOfIListOfPersonAffiliation
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonTravelNotification
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonAffiliation
object
Defines the JSON response contract.
3 properties
SegmentTripResult
object
Model data.
8 properties
PersonEditRequest
object
Defines the person create request.
5 properties 1 required
DeltaMapperOfUserRolePatchRequest
object
Map delta changes of a specific type T to another object.
2 properties
IJsonResponseOfUserRole
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonPhoneNumber
object
Defines the JSON response contract.
3 properties
DeltaMapperOfPersonCommentRequest
object
Map delta changes of a specific type T to another object.
2 properties
PersonAffiliation
object
Defines the person affiliation.
2 properties 1 required
IJsonResponseOfPersonTravelDocument
object
Defines the JSON response contract.
3 properties
PersonTravelDocument
object
Defines a specific person travel document.
15 properties 1 required
IJsonResponseOfIListOfPersonTravelDocument
object
Defines the JSON response contract.
3 properties
ErrorResponse
object
Defines a unique error response.
8 properties
PersonCustomerProgramEditRequest
object
Defines a person's customer program edit request.
5 properties 1 required
IJsonResponseOfIListOfNotificationEvent
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonPhoneNumber
object
Defines the JSON response contract.
3 properties
NotificationDestination
object
A travel notification destination.
2 properties 1 required
IJsonResponseOfIListOfPersonCustomerProgram
object
Defines the JSON response contract.
3 properties
PersonInformationEditRequest
object
Defines a person information edit request.
1 property
DeltaMapperOfPersonCustomerProgramEditRequest
object
Map delta changes of a specific type T to another object.
5 properties
PersonTravelNotification
object
A person travel notification.
7 properties
NotificationTimedEventEditRequest
object
A travel notification timed event edit request.
1 property
IJsonResponseOfPerson
object
Defines the JSON response contract.
3 properties
UserCreateRequestv2
object
Defines the v2 user create request.
14 properties 5 required
LiftStatus
integer
Lift status enumeration. 0 = Default 1 = CheckedIn 2 = Boarded 3 = NoShow
MessageStatus
integer
Defines the message status. 0 = General 1 = Warning 2 = Critical
DeltaMapperOfPersonAddressEditRequest
object
Map delta changes of a specific type T to another object.
8 properties
UserStatus
integer
Defines the status of a user. 0 = Default 1 = Active 2 = Pending 3 = Suspended 4 = Terminated
DeltaMapperOfTravelNotificationEditRequest
object
Map delta changes of a specific type T to another object.
3 properties
NotificationTimedEvent
object
A travel notification timed event.
3 properties 1 required
NotificationEvent
object
A travel notification event.
2 properties 1 required
EmailEditRequest
object
Defines the person email edit address.
2 properties 1 required
NotificationTimedEventType
integer
Represents the type of timed notification event type for a travel notification event. These are events that have an associated property minutes to event. 0 = D…
PersonCreateRequest
object
Defines the person create request.
16 properties 1 required
PersonStoredPaymentUpdateRequest
object
Defines the person's stored payment create request.
5 properties 2 required
PaymentMethodType
integer
Defines the payment method types. 0 = ExternalAccount 1 = PrePaid 2 = AgencyAccount 3 = CustomerAccount 4 = Voucher 5 = Loyalty
IJsonResponseOfIListOfBookingTripResult
object
Defines the JSON response contract.
3 properties
User
object
Defines a unique user.
18 properties 3 required
PersonStoredPayment
object
Defines a specific person's stored payment.
7 properties 3 required
SkySpeedSettingsUserPreferences
object
Defines the SkySpeed default settings for the currently logged in user.
7 properties
UserRequest
object
Defines the user request.
9 properties 2 required
PersonAliasType
integer
Defines the type of alternate name. 0 = Alias 1 = Variant
IJsonResponseOfIListOfUserRecord
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonPreference
object
Defines the JSON response contract.
3 properties
PersonPhoneNumberRequest
object
Defines the the person phone number.
3 properties 2 required
PaidStatus
integer
Paid status enumeration. 0 = UnderPaid 1 = PaidInFull 2 = OverPaid
DeltaMapperOfPersonAliasRequest
object
Map delta changes of a specific type T to another object.
6 properties
PersonComment
object
Defines a person comment.
7 properties
Name
object
Defines a common name.
5 properties
PersonAffiliationRequest
object
Defines the person affiliation.
1 property 1 required
PersonAddress
object
Defines a unique person address.
10 properties 1 required
IJsonResponseOfIListOfPersonInformation
object
Defines the JSON response contract.
3 properties
DeltaMapperOfPersonStoredPaymentUpdateRequest
object
Map delta changes of a specific type T to another object.
5 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
TransportationDesignator
object
Model information about the traveling arrival and destination details.
4 properties
IJsonResponseOfIListOfPersonEmail
object
Defines the JSON response contract.
3 properties
PersonCommentRequest
object
Defines a person comment request.
2 properties
IJsonResponseOfPersonEmail
object
Defines the JSON response contract.
3 properties
IJsonResponseOfNotificationEvent
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonTravelNotification
object
Defines the JSON response contract.
3 properties
DeltaMapperOfPersonInformationEditRequest
object
Map delta changes of a specific type T to another object.
1 property
IJsonResponseOfUser
object
Defines the JSON response contract.
3 properties
DeltaMapperOfTravelDocumentEditRequestv2
object
Map delta changes of a specific type T to another object.
12 properties
Person
object
Defines a person.
18 properties 1 required
TravelNotificationCreateRequest
object
Create request for travel notifications.
5 properties
PersonTravelDocumentRequest
object
Defines the person travel document.
14 properties 1 required
UserSetting
object
Defines the agent setting configuration.
6 properties
PersonStatus
integer
The status of the person. 0 = Active 1 = Terminated 2 = Suspended
IJsonResponseOfNotificationTimedEvent
object
Defines the JSON response contract.
3 properties
TravelNotificationEditRequest
object
Request base for travel notifications.
3 properties
PersonEmail
object
Defines a specific person email.
4 properties 2 required
PersonAddressCreateRequest
object
Defines a person address request.
9 properties 1 required
UserRole
object
Defines a user role.
7 properties 2 required
PersonAddressEditRequest
object
Defines the person address edit request.
8 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
CollectionCurrencySetting
integer
Defines to which the collection currency will be applied. 0 = None 1 = Payments 2 = Fees 3 = Both
NotificationEventCreateRequest
object
A travel notification event create request.
1 property 1 required
Message
object
Defines a unique informational message.
5 properties
UserCreateRequest
object
Defines the user create request.
14 properties 5 required
PriceStatus
integer
Describes the fare pricing status 0 = Invalid 1 = Override 2 = Valid
BookingTripResult
object
Booking flight result data.
9 properties
DeltaMapperOfPersonEditRequest
object
Map delta changes of a specific type T to another object.
5 properties
NotificationTimedEventCreateRequest
object
A travel notification timed event create request.
2 properties 1 required
Gender
integer
Defines the different binary gender types. 0 = XX 1 = Male 2 = Female
IJsonResponseOfPersonInformation
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonAddress
object
Defines the JSON response contract.
3 properties
UserRecord
object
Defines a user record.
8 properties
IJsonResponseOfIListOfUserRole
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfNotificationTimedEvent
object
Defines the JSON response contract.
3 properties
PersonType
integer
Defines the type of person. 0 = None 1 = Customer 2 = Agent
DeltaMapperOfPersonPhoneNumberRequest
object
Map delta changes of a specific type T to another object.
3 properties
MatchCriteria
integer
Defines the matching criteria for strings. 0 = StartsWith 1 = EndsWith 2 = Contains 3 = ExactMatch
PersonBasicInformation
object
Defines the person's basic information.
9 properties
EmailCreateRequest
object
Defines the person email create address.
3 properties 2 required
TransportationIdentifier
object
Represents the transportation identifier model data.
3 properties 2 required
PersonCommentType
integer
Defines the different types of person comments. 0 = Default 1 = Itinerary 2 = Manifest 3 = Alert 4 = Archive 5 = Voucher
PersonCustomerProgram
object
Defines a person's customer program.
16 properties 2 required
IJsonResponseOfIListOfBookingSearchResult
object
Defines the JSON response contract.
3 properties
PersonPreferenceEditRequest
object
Defines the person preference edit request.
1 property
FlightResultFareType
integer
Defines which fares will be included in the flight results. 0 = All 1 = Monetary 2 = Loyalty
PersonPhoneNumber
object
Defines a unique person phone number.
4 properties 2 required
DeltaMapperOfEmailEditRequest
object
Map delta changes of a specific type T to another object.
2 properties
IJsonResponseOfIListOfPersonAlias
object
Defines the JSON response contract.
3 properties
IJsonResponse
object
Defines the JSON response contract for a not content type response.
3 properties
IJsonResponseOfPersonComment
object
Defines the JSON response contract.
3 properties
NotificationPreference
integer
Describes types of notifications the user would prefer. 0 = None 1 = Promotional
IJsonResponseOfPersonAddress
object
Defines the JSON response contract.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs TUI Group publishes across the network.

TUI Group Account API
TUI Group Airline Profile 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
TUI Group Booking API
Where this information came from

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