API preview
API reference
Every operation an API key can call, with its parameters, fields and errors.
The reference describes the implemented API preview. Public access is coming soon. Dashboard routes, such as sign-in, members and billing, are not available to keys and are not listed.
- Base URL
- Every path starts with
/v1on your API origin. The examples read the origin fromCHARTEROPS_API_URL. Quickstart - Authentication
- Send a key as
Authorization: Bearer co_live_…. Each operation names the scope it needs,readorwrite. Authentication - Requests
- Bodies are JSON. Creates and transitions require an
Idempotency-Keyheader. Idempotency - Lists
- Lists return
items,next_cursorandtotal. Passcursorto read the next page. Pagination - Errors
- Errors are
application/problem+jsonwith atypeyou can act on. Errors and retries - Quota
- Calls that count use your organization's allowance and report it in the
X-Quota-*headers. Quotas and rate limits
Airports
Search airports and nearby fields, read the FBOs on a field, and add or update your own FBOs.
Aircraft
Search registered aircraft and aircraft types, and read an aircraft's operators and last position.
Operators
Search charter operators and read their fleets.
Estimates
Estimate a route's distance, flight time and price range. An estimate is not an operator quote.
Clients
Search, create and update the people and companies you fly.
Trips
Trip requests, the quotes you add to them, and the bookings they become.
- GETSearch trip requests
/v1/trip-requests - POSTCreate a trip request
/v1/trip-requests - POSTRead a pasted trip request
/v1/trip-requests/parse - GETRead the trip pipeline
/v1/trip-requests/summary - GETRead a trip request
/v1/trip-requests/{id} - PATCHUpdate a trip request
/v1/trip-requests/{id} - GETRead a trip request's timeline
/v1/trip-requests/{id}/events - GETRead a trip request's notes
/v1/trip-requests/{id}/notes - POSTAdd a note to a trip request
/v1/trip-requests/{id}/notes - POSTAdd a quote
/v1/trip-requests/{id}/quotes - POSTTransition a trip request
/v1/trip-requests/{id}/transitions - DELETEDelete a note
/v1/trip-notes/{id} - GETSearch quotes across trip requests
/v1/quotes - PATCHUpdate a draft quote
/v1/quotes/{id} - POSTTransition a quote
/v1/quotes/{id}/transitions - GETList bookings
/v1/bookings - GETRead a booking
/v1/bookings/{id} - POSTTransition a booking
/v1/bookings/{id}/transitions
Requests for quotes
Ask operators to quote a trip request, message them, and list the contacts you asked before.
- GETList a request's requests for quotes
/v1/trip-requests/{id}/rfqs - POSTRequest quotes from operators
/v1/trip-requests/{id}/rfqs - GETRead the messages on a request for quotes
/v1/rfqs/{id}/messages - POSTWrite on a request for quotes
/v1/rfqs/{id}/messages - POSTWithdraw a request for quotes
/v1/rfqs/{id}/withdrawals - GETList remembered operator contacts
/v1/operator-contacts
Empty legs
Search, post and book empty legs.
Marketplace
Publish redacted requests, submit aircraft offers, exchange private empty-leg inquiries, save partners and read your business briefing.
- GETList Inquiries
/v1/marketplace/inquiries - GETInquiry Detail
/v1/marketplace/inquiries/{id} - GETInquiry Messages
/v1/marketplace/inquiries/{id}/messages - POSTSend Inquiry Message
/v1/marketplace/inquiries/{id}/messages - POSTInquiry Offer
/v1/marketplace/inquiries/{id}/offer - POSTInquiry Transition
/v1/marketplace/inquiries/{id}/transitions - GETList Offers
/v1/marketplace/offers - GETOffer Detail
/v1/marketplace/offers/{id} - POSTOffer Quote
/v1/marketplace/offers/{id}/quote - POSTReplace Offer
/v1/marketplace/offers/{id}/replacement - POSTWithdraw Offer
/v1/marketplace/offers/{id}/withdrawal - GETRequests
/v1/marketplace/requests - GETDetail
/v1/marketplace/requests/{id} - GETRequest Offers
/v1/marketplace/requests/{id}/offers - POSTCreate Offer
/v1/marketplace/requests/{id}/offers - GETSaved Partners
/v1/marketplace/saved-partners - PUTSave Partner
/v1/marketplace/saved-partners/{kind}/{id} - DELETERemove Partner
/v1/marketplace/saved-partners/{kind}/{id} - POSTPublication
/v1/trip-requests/{id}/publication - POSTCreate Inquiry
/v1/empty-legs/{id}/inquiries - GETActivity
/v1/overview/activity - GETAttention
/v1/overview/attention - GETBusiness Summary
/v1/overview/summary
Campaigns
List the empty-leg campaigns you sent and read what each one brought back.