This article described the Retrieve by Tail API. This endpoint returns a Flight Object. The flights endpoint is secured with a unique org level Token. An organization must be configured to store by tail. Reading flights will require access to the tail endpoint. Only organizations configured to Store by Tail can access the Retrieve by Tail endpoint. For access, contact team@cloudahoy.com.
Accessing the Retrieve by Tail Endpoint
The endpoint is available at
https://www.cloudahoy.com/integration/v1/org/flights/tail/<tail number>
All requests to secured endpoints must include an Authorization header, which provides the access token on behalf of which the request is being made:
Authorization: Bearer <org's access token>
Getting a Tail’s Flights
Executing an HTTP GET on the flights endpoint, providing the appropriate access token, will return all flights in the specified window which were flown in that tail.
Query String Parameters
The list of returned flights may be filtered using the following query string parameters:
| Parameter | Type | Description |
|---|---|---|
page |
integer | The 1-based page number of results to be retrieved, based on pageSize |
pageSize |
integer |
Optional The number of flights to include in a page of results. The maximum allowed value is |
start |
integer |
Optional The date/time, specified in seconds since epoch GMT, of the earliest flight that will be returned in the result set. If not provided, the result set will start with the user's earliest flight. |
end |
integer |
Optional The date/time, specified in seconds since epoch GMT, of the most recent flight that will be returned in the result set. If not provided, the current date/time is assumed. |
thumbnailWidth |
integer |
Optional The width, in pixels, of the thumbnail image of each flight. Note that the images have a fixed W:H ratio of |
A successful request will result in a 200 status code and an array of flight objects.
See CloudAhoy Flight Return Object API for more information on the flight object.
Last Updated: