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

The persons API from TUI Group — 41 operation(s) for persons.

TUI Group Persons 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 Persons. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 96 operations across 41 paths, and defines 121 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.

96 operations 41 paths 121 schemas 15 DELETE35 GET12 PATCH18 POST16 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 Persons 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 96

Across 41 paths, the API surfaces 96 operations — 15 DELETE, 35 GET, 12 PATCH, 18 POST, 16 PUT. Each is listed below with its method, path, parameters, and response codes.

persons 96
POST
/api/nsk/v1/persons
Creates a new person record (used by agents).
nsk_v1_persons_post body → 201400403
GET
/api/nsk/v2/persons
Search person records.
nsk_v2_persons_get 15 params → 404200
GET
/api/nsk/v1/persons/{personKey}
Retrieves a specific person by key.
nsk_v1_persons_personKey_get 1 param → 404200
PUT
/api/nsk/v1/persons/{personKey}
Updates the person record basic information.
nsk_v1_persons_personKey_put 1 param body → 200400401500
PATCH
/api/nsk/v1/persons/{personKey}
Patches the person record basic information.
nsk_v1_persons_personKey_patch 1 param body → 200400401500
DELETE
/api/nsk/v1/persons/{personKey}
Deletes a person by setting the record to terminated.
nsk_v1_persons_personKey_delete 1 param → 200
GET
/api/nsk/v1/persons/{personKey}/account
Retrieves the person account and credits based on the person key.
nsk_v1_persons_personKey_account_get 2 params → 404200
POST
/api/nsk/v1/persons/{personKey}/account
Creates the person account based on the person key and data in the request.
nsk_v1_persons_personKey_account_post 1 param body → 201400
POST
/api/nsk/v1/persons/{personKey}/account/collection
Creates an account collection based on the person key and data in the request.
nsk_v1_persons_personKey_account_collection_post 1 param body → 201400
GET
/api/nsk/v1/persons/{personKey}/account/collection/{accountCollectionKey}/transactionsdeprecated
Retrieves the person account collection transactions based on the person key, the account collection key, and data in the request.
nsk_v1_persons_personKey_account_collection_accountCollectionKey_transactions_get 7 params → 200400
POST
/api/nsk/v1/persons/{personKey}/account/collection/{accountCollectionKey}/transactions
Creates an account collection transaction based on the person key, the account collection key, and data in the request.
nsk_v1_persons_personKey_account_collection_accountCollectionKey_transactions_post 2 params body → 201400
GET
/api/nsk/v2/persons/{personKey}/account/collection/{accountCollectionKey}/transactions
Retrieves the person account collection transactions based on the person key, the account collection key, and data in the request.
nsk_v2_persons_personKey_account_collection_accountCollectionKey_transactions_get 7 params → 200400
PUT
/api/nsk/v1/persons/{personKey}/account/status
Updates the person account status.
nsk_v1_persons_personKey_account_status_put 2 params → 200500
GET
/api/nsk/v1/persons/{personKey}/account/transactionsdeprecated
Retrieves all transactions for every collection.
nsk_v1_persons_personKey_account_transactions_get 6 params → 200400
GET
/api/nsk/v2/persons/{personKey}/account/transactions
Retrieves all persons account transactions.
nsk_v2_persons_personKey_account_transactions_get 6 params → 200400
GET
/api/nsk/v1/persons/{personKey}/addresses
Gets the collection of addresses for a specific person.
nsk_v1_persons_personKey_addresses_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/addresses
Creates a new address for a specific person.
nsk_v1_persons_personKey_addresses_post 1 param body → 201
GET
/api/nsk/v1/persons/{personKey}/addresses/{personAddressKey}
Gets a specific address for a specific person.
nsk_v1_persons_personKey_addresses_personAddressKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/addresses/{personAddressKey}
Updates a specific address for a specific person.
nsk_v1_persons_personKey_addresses_personAddressKey_put 2 params body → 200500
PATCH
/api/nsk/v1/persons/{personKey}/addresses/{personAddressKey}
Patches a specific address for a specific person.
nsk_v1_persons_personKey_addresses_personAddressKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/persons/{personKey}/addresses/{personAddressKey}
Deletes a specific address for a specific person.
nsk_v1_persons_personKey_addresses_personAddressKey_delete 2 params → 200
GET
/api/nsk/v1/persons/{personKey}/affiliations
Gets all affiliations for a specific person.
nsk_v1_persons_personKey_affiliations_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/affiliations
Creates a new affiliation for a specific person.
nsk_v1_persons_personKey_affiliations_post 1 param body → 201400401
GET
/api/nsk/v1/persons/{personKey}/affiliations/{personAffiliationKey}
Gets a specific affiliation for a specific person.
nsk_v1_persons_personKey_affiliations_personAffiliationKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/affiliations/{personAffiliationKey}
Updates a specific affiliation for a specific person.
nsk_v1_persons_personKey_affiliations_personAffiliationKey_put 2 params body → 200400401500
DELETE
/api/nsk/v1/persons/{personKey}/affiliations/{personAffiliationKey}
Deletes a specific affiliation for a specific person.
nsk_v1_persons_personKey_affiliations_personAffiliationKey_delete 2 params → 200400401
GET
/api/nsk/v1/persons/{personKey}/aliases
Gets the collection of aliases for a specific person.
nsk_v1_persons_personKey_aliases_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/aliases
Creates a new alias for a specific person.
nsk_v1_persons_personKey_aliases_post 1 param body → 201400401
GET
/api/nsk/v1/persons/{personKey}/aliases/{personAliasKey}
Gets a specific alias for a specific person.
nsk_v1_persons_personKey_aliases_personAliasKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/aliases/{personAliasKey}
Updates a specific alias for a specific person.
nsk_v1_persons_personKey_aliases_personAliasKey_put 2 params body → 200400401500
PATCH
/api/nsk/v1/persons/{personKey}/aliases/{personAliasKey}
Patches a specific alias for a specific person.
nsk_v1_persons_personKey_aliases_personAliasKey_patch 2 params body → 200400401500
DELETE
/api/nsk/v1/persons/{personKey}/aliases/{personAliasKey}
Deletes a specific alias for a specific person.
nsk_v1_persons_personKey_aliases_personAliasKey_delete 2 params → 200400401
GET
/api/nsk/v1/persons/{personKey}/comments
Gets the collection of comments for a specific person.
nsk_v1_persons_personKey_comments_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/comments
Creates a new comment for a specific person.
nsk_v1_persons_personKey_comments_post 1 param body → 201400401
GET
/api/nsk/v1/persons/{personKey}/comments/{personCommentKey}
Gets a specific comment for a specific person.
nsk_v1_persons_personKey_comments_personCommentKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/comments/{personCommentKey}
Updates a specific comment for a specific person.
nsk_v1_persons_personKey_comments_personCommentKey_put 2 params body → 200400401500
PATCH
/api/nsk/v1/persons/{personKey}/comments/{personCommentKey}
Patches a specific comment for a specific person.
nsk_v1_persons_personKey_comments_personCommentKey_patch 2 params body → 200400401500
DELETE
/api/nsk/v1/persons/{personKey}/comments/{personCommentKey}
Deletes a specific comment for a specific person.
nsk_v1_persons_personKey_comments_personCommentKey_delete 2 params → 200400401
GET
/api/nsk/v1/persons/{personKey}/emails
Gets the collection of email addresses for a specific person.
nsk_v1_persons_personKey_emails_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/emails
Creates a new email address for a specific person.
nsk_v1_persons_personKey_emails_post 1 param body → 201
GET
/api/nsk/v1/persons/{personKey}/emails/{personEmailAddressKey}
Gets a specific email address for a specific person.
nsk_v1_persons_personKey_emails_personEmailAddressKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/emails/{personEmailAddressKey}
Updates a specific email address for a specific person.
nsk_v1_persons_personKey_emails_personEmailAddressKey_put 2 params body → 200500
PATCH
/api/nsk/v1/persons/{personKey}/emails/{personEmailAddressKey}
Patches a specific email address for a specific person.
nsk_v1_persons_personKey_emails_personEmailAddressKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/persons/{personKey}/emails/{personEmailAddressKey}
Deletes a specific email address for a specific person.
nsk_v1_persons_personKey_emails_personEmailAddressKey_delete 2 params → 200
GET
/api/nsk/v1/persons/{personKey}/information
Gets all information for a specific person.
nsk_v1_persons_personKey_information_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/information
Creates new information for a specific person.
nsk_v1_persons_personKey_information_post 1 param body → 201400
GET
/api/nsk/v1/persons/{personKey}/information/{personInformationKey}
Gets specific information for a specific person.
nsk_v1_persons_personKey_information_personInformationKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/information/{personInformationKey}
Updates specific information for a specific person.
nsk_v1_persons_personKey_information_personInformationKey_put 2 params body → 200400500
PATCH
/api/nsk/v1/persons/{personKey}/information/{personInformationKey}
Patches specific information for a specific person.
nsk_v1_persons_personKey_information_personInformationKey_patch 2 params body → 200400500
DELETE
/api/nsk/v1/persons/{personKey}/information/{personInformationKey}
Deletes specific information for a specific person.
nsk_v1_persons_personKey_information_personInformationKey_delete 2 params → 200
PUT
/api/nsk/v1/persons/{personKey}/merge
Updates a person by merging the PNRs associated, account information and optionally the customer programs.
nsk_v1_persons_personKey_merge_put 1 param body → 200
GET
/api/nsk/v1/persons/{personKey}/phoneNumbers
Gets the collection of phone numbers for a specific person.
nsk_v1_persons_personKey_phoneNumbers_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/phoneNumbers
Creates a new phone number for a specific person.
nsk_v1_persons_personKey_phoneNumbers_post 1 param body → 201
GET
/api/nsk/v1/persons/{personKey}/phoneNumbers/{personPhoneNumberKey}
Gets a specific phone number for a specific person.
nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/phoneNumbers/{personPhoneNumberKey}
Updates a specific phone number for a specific person.
nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_put 2 params body → 200500
PATCH
/api/nsk/v1/persons/{personKey}/phoneNumbers/{personPhoneNumberKey}
Patches a specific phone number for a specific person.
nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/persons/{personKey}/phoneNumbers/{personPhoneNumberKey}
Deletes a specific phone number for a specific person.
nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_delete 2 params → 200
GET
/api/nsk/v1/persons/{personKey}/preferences
Gets all preferences for a specific person.
nsk_v1_persons_personKey_preferences_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/preferences
Creates a new preference for a specific person.
nsk_v1_persons_personKey_preferences_post 1 param body → 201
GET
/api/nsk/v1/persons/{personKey}/preferences/{personPreferenceKey}
Gets a specific preference for a specific person.
nsk_v1_persons_personKey_preferences_personPreferenceKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/preferences/{personPreferenceKey}
Updates a specific preference for a specific person.
nsk_v1_persons_personKey_preferences_personPreferenceKey_put 2 params body → 200500
PATCH
/api/nsk/v1/persons/{personKey}/preferences/{personPreferenceKey}
Patches a specific preference for a specific person.
nsk_v1_persons_personKey_preferences_personPreferenceKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/persons/{personKey}/preferences/{personPreferenceKey}
Deletes a specific preference for a specific person.
nsk_v1_persons_personKey_preferences_personPreferenceKey_delete 2 params → 200
GET
/api/nsk/v1/persons/{personKey}/programs
Gets the collection of programs for a specific person.
nsk_v1_persons_personKey_programs_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/programs
Creates a new program for a specific person.
nsk_v1_persons_personKey_programs_post 1 param body → 201400401
GET
/api/nsk/v1/persons/{personKey}/programs/{personProgramKey}
Gets a specific program for a specific person.
nsk_v1_persons_personKey_programs_personProgramKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/programs/{personProgramKey}
Updates a specific program for a specific person.
nsk_v1_persons_personKey_programs_personProgramKey_put 2 params body → 200400401500
PATCH
/api/nsk/v1/persons/{personKey}/programs/{personProgramKey}
Patches a specific program for a specific person.
nsk_v1_persons_personKey_programs_personProgramKey_patch 2 params body → 200400401500
DELETE
/api/nsk/v1/persons/{personKey}/programs/{personProgramKey}
Deletes a specific program for a specific person.
nsk_v1_persons_personKey_programs_personProgramKey_delete 2 params → 200400401
GET
/api/nsk/v1/persons/{personKey}/storedPayments
Gets the collection of stored payments for a specific person.
nsk_v1_persons_personKey_storedPayments_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/storedPayments
Creates a new stored payment for a specific person.
nsk_v1_persons_personKey_storedPayments_post 1 param body → 201400403
GET
/api/nsk/v1/persons/{personKey}/storedPayments/{personStoredPaymentKey}
Gets a specific stored payment for a specific person.
nsk_v1_persons_personKey_storedPayments_personStoredPaymentKey_get 2 params → 404200
PATCH
/api/nsk/v1/persons/{personKey}/storedPayments/{personStoredPaymentKey}
Patches a specific stored payment for a specific person.
nsk_v1_persons_personKey_storedPayments_personStoredPaymentKey_patch 2 params body → 200400403500
DELETE
/api/nsk/v1/persons/{personKey}/storedPayments/{personStoredPaymentKey}
Deletes a specific stored payment for a specific person.
nsk_v1_persons_personKey_storedPayments_personStoredPaymentKey_delete 2 params → 200
PUT
/api/nsk/v2/persons/{personKey}/storedPayments/{personStoredPaymentKey}
Updates a specific stored payment for a specific person.
nsk_v2_persons_personKey_storedPayments_personStoredPaymentKey_put 2 params body → 200400403500
GET
/api/nsk/v1/persons/{personKey}/travelDocuments
Gets the collection of travel documents for a specific person.
nsk_v1_persons_personKey_travelDocuments_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/travelDocuments
Creates a new travel document for a specific person. Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object. This is by design due to New Skies v…
nsk_v1_persons_personKey_travelDocuments_post 1 param body → 201400401
GET
/api/nsk/v1/persons/{personKey}/travelDocuments/{personTravelDocumentKey}
Gets a specific travel document for a specific person.
nsk_v1_persons_personKey_travelDocuments_personTravelDocumentKey_get 2 params → 404200
DELETE
/api/nsk/v1/persons/{personKey}/travelDocuments/{personTravelDocumentKey}
Deletes a specific travel document for a specific person.
nsk_v1_persons_personKey_travelDocuments_personTravelDocumentKey_delete 2 params → 200400401
PUT
/api/nsk/v2/persons/{personKey}/travelDocuments/{personTravelDocumentKey}
Updates a specific travel document for a specific person.
nsk_v2_persons_personKey_travelDocuments_personTravelDocumentKey_put 2 params body → 200400401500
PATCH
/api/nsk/v2/persons/{personKey}/travelDocuments/{personTravelDocumentKey}
Patches a specific travel document for a specific person.
nsk_v2_persons_personKey_travelDocuments_personTravelDocumentKey_patch 2 params body → 200400401500
GET
/api/nsk/v1/persons/{personKey}/travelNotifications
Gets person travel notifications for a person.
nsk_v1_persons_personKey_travelNotifications_get 1 param → 404200
POST
/api/nsk/v1/persons/{personKey}/travelNotifications
Creates a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_post 1 param body → 201
GET
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}
Gets a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_get 2 params → 404200
PUT
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}
Updates a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_put 2 params body → 200500
PATCH
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}
Patches a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_patch 2 params body → 200500
DELETE
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}
Deletes a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_delete 2 params → 200
GET
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/events
Gets notification events for a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_get 2 params → 200404
POST
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/events
Creates a notification event for a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_post 2 params body → 201
GET
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/events/{eventType}
Gets a notification event for a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_eventType_get 3 params → 200404
DELETE
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/events/{eventType}
Deletes a notification event from a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_eventType_delete 3 params → 200
GET
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/timedEvents
Gets notification timed events for a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_get 2 params → 200404
POST
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/timedEvents
Creates a notification timed event for a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_post 2 params body → 201
GET
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}
Gets a notification timed event for a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_get 3 params → 200404
PUT
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}
Updates a notification timed event for a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_put 3 params body → 200500
DELETE
/api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}
Deletes a notification timed event from a person travel notification for a person.
nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_delete 3 params → 200

Schemas 121

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

NotificationTimedEventEditRequest
object
A travel notification timed event edit request.
1 property
AccountCollectionRequest
object
The account collection request model.
5 properties 2 required
Person
object
Defines a person.
18 properties 1 required
PagedTransactionResponse
object
The paged transaction response.
3 properties
PersonRecordsResponse
object
Defines the person record response.
2 properties
IJsonResponseOfIListOfPersonStoredPayment
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonCustomerProgram
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonTravelNotification
object
Defines the JSON response contract.
3 properties
PersonStatus
integer
The status of the person. 0 = Active 1 = Terminated 2 = Suspended
IJsonResponseOfPersonRecordsResponse
object
Defines the JSON response contract.
3 properties
PersonAddress
object
Defines a unique person address.
10 properties 1 required
NotificationTimedEventCreateRequest
object
A travel notification timed event create request.
2 properties 1 required
PersonCustomerProgramEditRequest
object
Defines a person's customer program edit request.
5 properties 1 required
IJsonResponseOfPersonPreference
object
Defines the JSON response contract.
3 properties
DeltaMapperOfPersonPreferenceEditRequest
object
Map delta changes of a specific type T to another object.
1 property
IJsonResponseOfPersonAddress
object
Defines the JSON response contract.
3 properties
PersonPreferenceEditRequest
object
Defines the person preference edit request.
1 property
Account
object
The account model.
14 properties
IJsonResponseOfIListOfPersonPhoneNumber
object
Defines the JSON response contract.
3 properties
PaymentMethodType
integer
Defines the payment method types. 0 = ExternalAccount 1 = PrePaid 2 = AgencyAccount 3 = CustomerAccount 4 = Voucher 5 = Loyalty
AccountCollection
object
The account collection model.
7 properties
IJsonResponseOfPersonAffiliation
object
Defines the JSON response contract.
3 properties
PersonEditRequest
object
Defines the person create request.
5 properties 1 required
IJsonResponseOfNotificationEvent
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonComment
object
Defines the JSON response contract.
3 properties
PersonAddressEditRequest
object
Defines the person address edit request.
8 properties
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…
PersonPhoneNumber
object
Defines a unique person phone number.
4 properties 2 required
PersonInformationEditRequest
object
Defines a person information edit request.
1 property
PersonPhoneNumberRequest
object
Defines the the person phone number.
3 properties 2 required
DeltaMapperOfTravelDocumentEditRequestv2
object
Map delta changes of a specific type T to another object.
12 properties
PersonAffiliationRequest
object
Defines the person affiliation.
1 property 1 required
PersonEmail
object
Defines a specific person email.
4 properties 2 required
PersonPreferenceCreateRequest
object
Defines a person preference create request.
2 properties
IJsonResponseOfPerson
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonStoredPayment
object
Defines the JSON response contract.
3 properties
TravelNotificationCreateRequest
object
Create request for travel notifications.
5 properties
PersonTravelNotification
object
A person travel notification.
7 properties
IJsonResponseOfIListOfNotificationEvent
object
Defines the JSON response contract.
3 properties
DeltaMapperOfPersonStoredPaymentUpdateRequest
object
Map delta changes of a specific type T to another object.
5 properties
IJsonResponseOfIListOfPersonInformation
object
Defines the JSON response contract.
3 properties
DeltaMapperOfPersonAddressEditRequest
object
Map delta changes of a specific type T to another object.
8 properties
PersonCommentRequest
object
Defines a person comment request.
2 properties
PersonStoredPaymentUpdateRequest
object
Defines the person's stored payment create request.
5 properties 2 required
PersonTravelDocument
object
Defines a specific person travel document.
15 properties 1 required
AccountType
integer
The account type enumeration. 0 = Credit 1 = Prepaid 2 = Supplementary 3 = Dependent 4 = Unknown
TravelNotificationEditRequest
object
Request base for travel notifications.
3 properties
DeltaMapperOfPersonCustomerProgramEditRequest
object
Map delta changes of a specific type T to another object.
5 properties
Gender
integer
Defines the different binary gender types. 0 = XX 1 = Male 2 = Female
IJsonResponseOfIListOfPersonEmail
object
Defines the JSON response contract.
3 properties
PersonTravelDocumentRequest
object
Defines the person travel document.
14 properties 1 required
IJsonResponseOfPersonEmail
object
Defines the JSON response contract.
3 properties
EmailEditRequest
object
Defines the person email edit address.
2 properties 1 required
DeltaMapperOfPersonEditRequest
object
Map delta changes of a specific type T to another object.
5 properties
PersonAffiliation
object
Defines the person affiliation.
2 properties 1 required
EmailCreateRequest
object
Defines the person email create address.
3 properties 2 required
IJsonResponseOfIListOfPersonAffiliation
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPagedTransactionResponse
object
Defines the JSON response contract.
3 properties
PersonComment
object
Defines a person comment.
7 properties
NotificationEventCreateRequest
object
A travel notification event create request.
1 property 1 required
PersonCustomerProgram
object
Defines a person's customer program.
16 properties 2 required
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
IJsonResponseOfAccount
object
Defines the JSON response contract.
3 properties
PersonStoredPaymentRequest
object
Defines the person's stored payment create request.
6 properties 3 required
Message
object
Defines a unique informational message.
5 properties
PersonCreateRequest
object
Defines the person create request.
16 properties 1 required
Transaction
object
The transaction model.
13 properties 2 required
IJsonResponseOfPersonAlias
object
Defines the JSON response contract.
3 properties
IJsonResponse
object
Defines the JSON response contract for a not content type response.
3 properties
DeliveryMethodCode
integer
Represents the delivery method codes. 0 = Email 1 = Sms 2 = Push
IJsonResponseOfNotificationTimedEvent
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonComment
object
Defines the JSON response contract.
3 properties
PersonMergeRequestBase
object
The base request to merge two persons with their program/s.
3 properties 1 required
PersonAddressCreateRequest
object
Defines a person address request.
9 properties 1 required
PersonAliasType
integer
Defines the type of alternate name. 0 = Alias 1 = Variant
IJsonResponseOfIListOfPersonAlias
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonTravelDocument
object
Defines the JSON response contract.
3 properties
PersonName
object
Defines a person name.
6 properties
MatchCriteria
integer
Defines the matching criteria for strings. 0 = StartsWith 1 = EndsWith 2 = Contains 3 = ExactMatch
Exception
object
4 properties
TravelDocumentEditRequestv2
object
Defines the edit travel document request.
12 properties 1 required
DeltaMapperOfPersonAliasRequest
object
Map delta changes of a specific type T to another object.
6 properties
IJsonResponseOfPersonCustomerProgram
object
Defines the JSON response contract.
3 properties
DeltaMapperOfPersonCommentRequest
object
Map delta changes of a specific type T to another object.
2 properties
DeltaMapperOfTravelNotificationEditRequest
object
Map delta changes of a specific type T to another object.
3 properties
Name
object
Defines a common name.
5 properties
Address
object
Defines a common address.
7 properties
DeltaMapperOfPersonPhoneNumberRequest
object
Map delta changes of a specific type T to another object.
3 properties
AccountStatus
integer
The account status enumeration. 0 = Open 1 = Closed 2 = AgencyInactive 3 = Unknown
IJsonResponseOfIListOfPersonTravelDocument
object
Defines the JSON response contract.
3 properties
NotificationPreference
integer
Describes types of notifications the user would prefer. 0 = None 1 = Promotional
DeltaMapperOfPersonInformationEditRequest
object
Map delta changes of a specific type T to another object.
1 property
PersonPreference
object
Defines the person preferences.
3 properties
TransactionType
integer
The dotREZ specific transaction types. This includes some system specific values that are not allowed during a transaction creation. 0 = Default 1 = Payment 2…
IJsonResponseOfPersonPhoneNumber
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonInformation
object
Defines the JSON response contract.
3 properties
AccountOwnerType
integer
The account owner type enumeration. 0 = Organization 1 = Personnal 2 = Booking 3 = Unknown
PersonCustomerProgramCreateRequest
object
Defines a person's customer program create request.
6 properties 2 required
PersonAlias
object
Defines a person's alternate name that they go by.
7 properties
PersonAliasRequest
object
Defines the person alias request.
6 properties
DeltaMapperOfEmailEditRequest
object
Map delta changes of a specific type T to another object.
2 properties
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
IJsonResponseOfIListOfTransaction
object
Defines the JSON response contract.
3 properties
NotificationDestination
object
A travel notification destination.
2 properties 1 required
PersonStoredPayment
object
Defines a specific person's stored payment.
7 properties 3 required
NotificationEvent
object
A travel notification event.
2 properties 1 required
NotificationEventType
integer
Represents the type of notification event type for a travel notification event. 0 = DepartureDelay 1 = ArrivalDelay 2 = ScheduleChange 3 = CheckIn 4 = GateInfo…
PersonInformationCreateRequest
object
Defines a person information create request.
2 properties 1 required
PersonRecord
object
Defines the person record.
9 properties
PersonType
integer
Defines the type of person. 0 = None 1 = Customer 2 = Agent
TransactionRequest
object
The create transaction request.
3 properties 2 required
NotificationTimedEvent
object
A travel notification timed event.
3 properties 1 required
PersonBasicInformation
object
Defines the person's basic information.
9 properties
ErrorResponse
object
Defines a unique error response.
8 properties
IJsonResponseOfIListOfNotificationTimedEvent
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfPersonAddress
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPersonTravelNotification
object
Defines the JSON response contract.
3 properties
CreateAccountRequest
object
The create account request model.
1 property
IJsonResponseOfIListOfPersonPreference
object
Defines the JSON response contract.
3 properties
PersonInformation
object
Defines the a person information.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tui-group-persons-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 Persons 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.