General
How do I request access to this API?
Access is requested through the TUI air links portal at https://tui-air-links.com. You will be issued OAuth 2.0 client credentials (a client id and secret) scoped to this API once your request is approved.
How do I authenticate?
The API uses OAuth 2.0 with the client credentials grant. You exchange your client id and secret for an access token at the token endpoint, then send that token as a Bearer token on every request. See the Technical Information page for the token URLs and example requests.
What scopes are available?
Three scopes are defined: aviation-crew-history.all for full access,
aviation-crew-history.read for read access, and
aviation-crew-history.write for write access. Most consumers only need the
read or all scope, since the API is read-only in practice.
Are there rate limits?
No specific rate limits are enforced by this API at present. Please use the service responsibly and prefer the file-based response option for very large queries.
How fresh is the data?
Data is sourced from the TUI crew tracking system and is refreshed at roughly five-minute intervals. Responses therefore reflect information that is about five minutes behind the live source.
Are there any date range constraints?
The startDate must be the same as or earlier than the endDate. Both dates
must use the yyyy-mm-dd format. Requests that break these rules return a
400 error.
Parameters
What is the difference between the day and month endpoints?
The day endpoints (/crew-history, /crews-history) return records for each
individual day. The month endpoints (/crew-history-month,
/crews-history-month) return duty time and block time accumulated per month.
What does the owner parameter mean?
The owner identifies the TUI airline the crew operate for (for example
TUI). It is required on the endpoints that return data for multiple crew
members.
What do the include flags do?
Flags such as includeOffDays, includeRecency, includeBlockTime and
includeDutyTime control which activity types appear in the response. They
default to false, so you must set the ones you need to true.
What does the active flag do?
When active is true (the default) only crew who are active at some point
in the requested period are returned. Set it to false to include all crew.
How do I filter by rank or home base?
The rank and homebase parameters accept multiple values and return crew
who held that rank or home base (IATA code) at any point within the date
range.
Responses
How are large responses handled?
If a result set is very large, or if you set responseFile=true, the API
stores the result as a JSON file in secure storage and returns a temporary
download link instead of the inline payload. See the Technical Information
page for the size threshold and link expiry.
What formats are supported?
Responses are returned as JSON. File-based responses are also stored as JSON.
What does a 204 response mean?
A 204 indicates the request was valid but no matching crew history data was
found for the given criteria.
Support
Who owns this API?
The API is owned by the AOPS Tech team (airtech-integration) within Airline Operations Technology.
How do I request a change or report a problem?
Raise a request through https://tui-air-links.com. This is the single entry
