get https://api.kevel.co/v1/flight
Lists all the flights in the network. For the explorer, use the API Key.
Why List Flights?
The List Flights
endpoint enables you to call the Flights endpoint and return an array of existing flights in the campaign.
The filter attribute specifies the set of flights that will be returned by selecting them based on the state of the IsArchived
and IsActive
properties.
Caution
Specifying both
filter
and eitherisActive
orisArchived
generates an error.
filter value | Includes flights where IsActive is | Includes flights where IsArchived is | Comments |
---|---|---|---|
not-archived | Any value | false or null | The default - omitting the filter attribute is equivalent to specifying this value. |
archived | Any value | true | |
active | true | false or null | |
inactive | false | false or null |
API Syntax
When using the List Flights API, it is important to understand the syntax required to make the request. Because the Kevel API is a RESTful API, there is a specific request format that must be followed to ensure the endpoint can process the request. The format is:
GET https://api.kevel.co/v1/flight
Where:
GET
- the type of API request being made.https://api.kevel.co
- the URL for the request.v1
- the API version.flight
- the API endpoint being called.