Read Accounts & Users

Read User or Passenger Data

GET /api/external/user/{externalReference}

When working with /user endpoints the externalReference is needed.

Example of a User Record

{  
    "externalReference": "fl3xx_107820",  
    "internalId": 107820,  
    "firstName": "Francesco",  
    "lastName": "Totti10",  
...

Users Created by Your Integration

Users created by your integration may be designated a unique externalReference (one will be automatically assigned otherwise, and can be retrieved from the response received when creating the user). These externalReference identifiers can be stored on your end to maintain a mapping between data existing outside of FL3XX and the associated users created within FL3XX by your integration.

Other Users

To identify user records for which you do not possess an externalReference, the following format may be used:

"fl3xx_" + internalId (or paxUserId)

For example, to construct an externalReference of this form for a user with "internalId": 123456 in this way:

"externalReference": "fl3xx_123456",

To find the paxUserId refer this document.

Read Accounts Data

GET /api/external/user/account/{externalReference}

At the moment is only possible to read accounts via the API if the account was created via the API and externalReference was provided.

Here a basic example of account retreived with the externalReference

{  
    "externalReference": "4259ac90-82d1-4ec0-ac82-313d35bd8615",  
    "name": "Alien Test",  
    "accountid": 24990,  
    "accountNumber": "2294",  
    "links": \[]  
}