Work Order API Documentation

This is the documentation to access the Work Order API, available exclusively to Aviation Flights Business accounts. It returns information about each posted Work order for aircraft in the database.

The API Platform is only available via a REST API, in which you have to let your application grab a URL with parameters and it returns all output in either JSON format. This makes it easy to grab the data using any Programming Language of your choice.

The root URL for the API is:

GET https://aviation.flights/api/workorder

Rate Limits

For the longest time it didn't need to be done but as of February 4, 2025 there is now a temporary rate limit of one request per 5 seconds.

Required Header Request

The following header is required on all requests:

x-api-key: The API key provided to you

Output Values for JSON

The following output values are returned after successful query:

Error Codes for JSON

The following are all error codes that can be returned with this function:

Sample Output

{
  "status": "success",
  "results": [
    {
      "workorder": [
        {
          "user_workorder_id": "4",
          "aircraft_id": "15123",
          "aircraft_msn": "2101",
          "aircraft_type": "A330-941",
          "title": "Flight Test OSR-OSR",
          "description": "
Functional Flight testing. test
",
          "color": "#ff00ff",
          "work_type": "Flight Activity",
          "start_date": "2025-08-25 14:30:00",
          "end_date": "2025-08-25 17:15:00"
        },
        {
          "user_workorder_id": "5",
          "aircraft_id": "15461",
          "aircraft_msn": "12412",
          "aircraft_type": "A321-253NY",
          "title": "Customer Acceptance",
          "description": "
Need to do customer acceptance inspection before delivery.
",
          "color": "#ff9900",
          "work_type": "Acceptance",
          "start_date": "2025-08-20 08:00:00",
          "end_date": "2025-08-27 17:00:00"
        }
      ]
    }
  ]
}