CharterOpsCharterOps

API reference

Trips

Trip requests, the quotes you add to them, and the bookings they become.

Search trip requests

GET/v1/trip-requests

Scope
read
Quota
Counts toward your allowance

Query parameters

  • booked_fromdate-time

  • booked_beforedate-time

  • created_by_meboolean

    Defaults to false.

  • activeboolean

    Defaults to false.

  • awaiting_responseboolean

    Defaults to false.

  • status[]array of strings

    One ofopenquotedbookedcompleteddeclinedcancelled

  • category[]array of strings

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • staleboolean

  • needs_attentionboolean

  • assigned_toUUID

  • client_idUUID

  • passenger_idUUID

  • from_datedate

  • to_datedate

  • qstring

    Up to 120 characters.

  • sortstring

    Defaults to -updated_at.

    One of-updated_atupdated_atnumber-numberfirst_depart_date-first_depart_dateclient-clientpax-paxpreferred_category-preferred_categoryquote_count-quote_countstatus-statusassigned_to-assigned_to

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

Response

200 OK

Returns a page of trip request summary objects in items, with next_cursor and total.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/trip-requests" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Create a trip request

POST/v1/trip-requests

Scope
write
Quota
Counts toward your allowance

Headers

  • Idempotency-KeystringRequired

    1 to 200 characters.

Request body

  • legsarray of objectsRequired

    1 to 10 items.

    8 fields in legs

    • depart_datedateRequired

    • fromstringRequired

      1 to 20 characters.

    • tostringRequired

      1 to 20 characters.

    • arrive_atdate-time

    • depart_timetime

    • depart_timezonestring

      Up to 100 characters.

    • latest_depart_datedate

    • paxinteger

      From 1 to 50.

  • paxintegerRequired

    From 1 to 50.

  • assigned_toUUID

  • budget_centsinteger

    0 or more.

  • budget_min_centsinteger

    0 or more.

  • client_idUUID

  • marketplace_publishedboolean

    Defaults to false.

  • notesstring

    Up to 2,000 characters.

  • preferred_categorystring

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • raw_textstring

    1 to 30,000 characters.

Response

201 Created

Returns the trip request object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request POST "$CHARTEROPS_API_URL/v1/trip-requests" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --header "Idempotency-Key: $(uuidgen)" \
  --json @body.json

Read a pasted trip request

POST/v1/trip-requests/parse

Scope
write
Quota
Counts toward your allowance

Request body

  • raw_textstringRequired

    1 to 30,000 characters.

Response

200 OK

Returns the parsed draft object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests
  • 503 Service unavailable

How to handle errors

Example request

curl --request POST "$CHARTEROPS_API_URL/v1/trip-requests/parse" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --json @body.json

Read the trip pipeline

GET/v1/trip-requests/summary

Scope
read
Quota
Counts toward your allowance

Response

200 OK

Returns the pipeline summary object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/trip-requests/summary" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Read a trip request

GET/v1/trip-requests/{id}

Scope
read
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Response

200 OK

Returns the trip request object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/trip-requests/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Update a trip request

PATCH/v1/trip-requests/{id}

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Request body

  • aircraft_idUUID

  • assigned_toUUID

  • budget_centsinteger

    0 or more.

  • budget_min_centsinteger

    0 or more.

  • client_idUUID

  • legsarray of objects

    1 to 10 items.

    8 fields in legs

    • depart_datedateRequired

    • fromstringRequired

      1 to 20 characters.

    • tostringRequired

      1 to 20 characters.

    • arrive_atdate-time

    • depart_timetime

    • depart_timezonestring

      Up to 100 characters.

    • latest_depart_datedate

    • paxinteger

      From 1 to 50.

  • notesstring

    Up to 2,000 characters.

  • paxinteger

    From 1 to 50.

  • pic_idUUID

  • preferred_categorystring

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • sic_idUUID

Response

200 OK

Returns the trip request object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request PATCH "$CHARTEROPS_API_URL/v1/trip-requests/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --json @body.json

Read a trip request's timeline

GET/v1/trip-requests/{id}/events

Scope
read
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Query parameters

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

Response

200 OK

Returns a page of trip event objects in items, with next_cursor and total.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/trip-requests/$ID/events" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Read a trip request's notes

GET/v1/trip-requests/{id}/notes

Scope
read
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Query parameters

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

Response

200 OK

Returns a page of trip note objects in items, with next_cursor and total.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/trip-requests/$ID/notes" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Add a note to a trip request

POST/v1/trip-requests/{id}/notes

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Headers

  • Idempotency-KeystringRequired

    1 to 200 characters.

Request body

  • bodystringRequired

    1 to 2,000 characters.

Response

201 Created

Returns the trip note object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request POST "$CHARTEROPS_API_URL/v1/trip-requests/$ID/notes" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --header "Idempotency-Key: $(uuidgen)" \
  --json @body.json

Add a quote

POST/v1/trip-requests/{id}/quotes

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Headers

  • Idempotency-KeystringRequired

    1 to 200 characters.

Request body

  • aircraft_idUUID

  • aircraft_type_idUUID

  • amount_centsinteger

    0 or more.

  • estimate_categorystring

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • line_itemsarray of objects

    Up to 20 items.

    5 fields in line_items

    • amount_centsintegerRequired

      0 or more.

    • labelstringRequired

      1 to 80 characters.

    • kindstring

      Defaults to custom.

      One ofaircraft_timecrew_dayovernightcateringground_transporttaxes_feescustom

    • quantitynumber

      More than 0 and up to 10,000. Defaults to 1.

    • rate_centsinteger

      0 or more.

  • notesstring

    Up to 2,000 characters.

  • operator_idUUID

  • sourcestring

    Defaults to manual.

    One ofmanualestimate

  • valid_untildate-time

Response

201 Created

Returns the quote object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request POST "$CHARTEROPS_API_URL/v1/trip-requests/$ID/quotes" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --header "Idempotency-Key: $(uuidgen)" \
  --json @body.json

Transition a trip request

POST/v1/trip-requests/{id}/transitions

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Headers

  • Idempotency-KeystringRequired

    1 to 200 characters.

Request body

  • tostringRequired

    Up to 20 characters.

Response

200 OK

Returns the trip request object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request POST "$CHARTEROPS_API_URL/v1/trip-requests/$ID/transitions" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --header "Idempotency-Key: $(uuidgen)" \
  --json @body.json

Delete a note

DELETE/v1/trip-notes/{id}

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Response

204 No content

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request DELETE "$CHARTEROPS_API_URL/v1/trip-notes/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Search quotes across trip requests

GET/v1/quotes

Scope
read
Quota
Counts toward your allowance

Query parameters

  • qstring

    Up to 120 characters.

  • statusstring

    One ofdraftsentaccepteddeclinedexpired

  • sortstring

    Defaults to -created_at.

    One ofcreated_at-created_atnumber-numberoperator-operatoraircraft-aircraftamount_cents-amount_centsvalid_until-valid_untilstatus-status

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

Response

200 OK

Returns a page of quote listed objects in items, with next_cursor and total.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/quotes" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Update a draft quote

PATCH/v1/quotes/{id}

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Request body

  • aircraft_idUUID

  • aircraft_type_idUUID

  • amount_centsinteger

    0 or more.

  • line_itemsarray of objects

    Up to 20 items.

    5 fields in line_items

    • amount_centsintegerRequired

      0 or more.

    • labelstringRequired

      1 to 80 characters.

    • kindstring

      Defaults to custom.

      One ofaircraft_timecrew_dayovernightcateringground_transporttaxes_feescustom

    • quantitynumber

      More than 0 and up to 10,000. Defaults to 1.

    • rate_centsinteger

      0 or more.

  • notesstring

    Up to 2,000 characters.

  • operator_idUUID

  • valid_untildate-time

Response

200 OK

Returns the quote object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request PATCH "$CHARTEROPS_API_URL/v1/quotes/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --json @body.json

Transition a quote

POST/v1/quotes/{id}/transitions

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Headers

  • Idempotency-KeystringRequired

    1 to 200 characters.

Request body

  • tostringRequired

    Up to 20 characters.

Response

200 OK

Returns the quote object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request POST "$CHARTEROPS_API_URL/v1/quotes/$ID/transitions" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --header "Idempotency-Key: $(uuidgen)" \
  --json @body.json

List bookings

GET/v1/bookings

Scope
read
Quota
Counts toward your allowance

Query parameters

  • status[]array of strings

    One ofconfirmedcompletedcancelled

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

Response

200 OK

Returns a page of booking objects in items, with next_cursor and total.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/bookings" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Read a booking

GET/v1/bookings/{id}

Scope
read
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Response

200 OK

Returns the booking object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl "$CHARTEROPS_API_URL/v1/bookings/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Transition a booking

POST/v1/bookings/{id}/transitions

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Headers

  • Idempotency-KeystringRequired

    1 to 200 characters.

Request body

  • tostringRequired

    Up to 20 characters.

Response

200 OK

Returns the booking object.

Errors

  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 422 Unprocessable content
  • 429 Too many requests

How to handle errors

Example request

curl --request POST "$CHARTEROPS_API_URL/v1/bookings/$ID/transitions" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --header "Idempotency-Key: $(uuidgen)" \
  --json @body.json

Objects

Trip request summary

  • assigned_toobjectCan be null

    3 fields in assigned_to

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • bookingobjectCan be null

    5 fields in booking

    • idUUID

    • itinerary_shared_atdate-timeCan be null

    • itinerary_viewed_atdate-timeCan be null

    • referencestring

    • statusstring

  • budget_centsintegerCan be null

  • budget_min_centsintegerCan be null

  • clientobjectCan be null

    4 fields in client

    • companystringCan be null

    • idUUID

    • namestring

    • timezonestring

  • created_atdate-time

  • currencystring

  • external_trip_idstringCan be null

  • first_legobjectCan be null

    12 fields in first_leg

    • arrive_atdate-timeCan be null

    • depart_datedate

    • depart_timetimeCan be null

    • depart_timezonestringCan be null

    • distance_nminteger

    • fromobject

      10 fields in from

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • idUUID

    • latest_depart_datedateCan be null

    • paxintegerCan be null

    • seqinteger

    • timezonestring

    • toobject

      10 fields in to

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

  • idUUID

  • import_batch_idUUIDCan be null

  • is_staleboolean

  • last_arrivalobjectCan be null

    10 fields in last_arrival

    • citystringCan be null

    • codestring

    • countrystring

    • iatastringCan be null

    • icaostringCan be null

    • idUUID

    • latitudenumber

    • longitudenumber

    • namestring

    • timezonestringCan be null

  • latest_quoteobjectCan be null

    8 fields in latest_quote

    • amount_centsinteger

    • currencystring

    • idUUID

    • is_expiredboolean

    • operator_namestringCan be null

    • sent_atdate-timeCan be null

    • statusstring

    • valid_untildate-timeCan be null

  • leg_countinteger

  • legsarray of objects

    12 fields in legs

    • arrive_atdate-timeCan be null

    • depart_datedate

    • depart_timetimeCan be null

    • depart_timezonestringCan be null

    • distance_nminteger

    • fromobject

      10 fields in from

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • idUUID

    • latest_depart_datedateCan be null

    • paxintegerCan be null

    • seqinteger

    • timezonestring

    • toobject

      10 fields in to

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

  • marketplace_publishedboolean

  • marketplace_versioninteger

  • numberinteger

  • parse_statusstringCan be null

    One ofpendingdonefailed

  • paxintegerCan be null

  • preferred_categorystringCan be null

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • quote_countinteger

  • sourcestring

    One ofmanualapiparsedcampaignportalcsv

  • source_systemstringCan be null

  • statusstring

    One ofopenquotedbookedcompleteddeclinedcancelled

  • updated_atdate-time

Trip request

  • assigned_toobjectCan be null

    3 fields in assigned_to

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • bookingobjectCan be null

    9 fields in booking

    • confirmed_atdate-time

    • idUUID

    • itinerary_shared_atdate-timeCan be null

    • itinerary_viewed_atdate-timeCan be null

    • notesstringCan be null

    • quoteobject

      22 fields in quote

      • aircraftobjectCan be null

        3 fields in aircraft

        • idUUID

        • registrationstring

        • typeobjectCan be null

          5 fields in type

          • categorystring

            One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

          • icao_designatorstring

          • idUUID

          • manufacturerstring

          • modelstring

      • aircraft_typeobjectCan be null

        5 fields in aircraft_type

        • categorystring

          One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

        • icao_designatorstring

        • idUUID

        • manufacturerstring

        • modelstring

      • amount_centsinteger

      • created_atdate-time

      • created_byobjectCan be null

        3 fields in created_by

        • avatar_urlstringCan be null

        • display_namestring

        • user_idUUIDCan be null

      • currencystring

      • idUUID

      • is_expiredboolean

      • line_itemsarray of objectsCan be null

        5 fields in line_items

        • amount_centsinteger

        • kindstring

          One ofaircraft_timecrew_dayovernightcateringground_transporttaxes_feescustom

        • labelstring

        • quantitynumber

        • rate_centsinteger

      • notesstringCan be null

      • operatorobjectCan be null

        4 fields in operator

        • dba_namestringCan be null

        • designatorstring

        • idUUID

        • legal_namestring

      • responded_atdate-timeCan be null

      • responder_namestringCan be null

      • response_notestringCan be null

      • sent_atdate-timeCan be null

      • shared_atdate-timeCan be null

      • sourcestring

      • statusstring

      • trip_request_idUUID

      • updated_atdate-time

      • valid_untildate-timeCan be null

      • viewed_atdate-timeCan be null

    • referencestring

    • statusstring

    • trip_requestobjectCan be null

      27 fields in trip_request

      • assigned_toobjectCan be null

        3 fields in assigned_to

        • avatar_urlstringCan be null

        • display_namestring

        • user_idUUIDCan be null

      • bookingobjectCan be null

        5 fields in booking

        • idUUID

        • itinerary_shared_atdate-timeCan be null

        • itinerary_viewed_atdate-timeCan be null

        • referencestring

        • statusstring

      • budget_centsintegerCan be null

      • budget_min_centsintegerCan be null

      • clientobjectCan be null

        4 fields in client

        • companystringCan be null

        • idUUID

        • namestring

        • timezonestring

      • created_atdate-time

      • currencystring

      • external_trip_idstringCan be null

      • first_legobjectCan be null

        12 fields in first_leg

        • arrive_atdate-timeCan be null

        • depart_datedate

        • depart_timetimeCan be null

        • depart_timezonestringCan be null

        • distance_nminteger

        • fromobject

          10 fields in from

          • citystringCan be null

          • codestring

          • countrystring

          • iatastringCan be null

          • icaostringCan be null

          • idUUID

          • latitudenumber

          • longitudenumber

          • namestring

          • timezonestringCan be null

        • idUUID

        • latest_depart_datedateCan be null

        • paxintegerCan be null

        • seqinteger

        • timezonestring

        • toobject

          10 fields in to

          • citystringCan be null

          • codestring

          • countrystring

          • iatastringCan be null

          • icaostringCan be null

          • idUUID

          • latitudenumber

          • longitudenumber

          • namestring

          • timezonestringCan be null

      • idUUID

      • import_batch_idUUIDCan be null

      • is_staleboolean

      • last_arrivalobjectCan be null

        10 fields in last_arrival

        • citystringCan be null

        • codestring

        • countrystring

        • iatastringCan be null

        • icaostringCan be null

        • idUUID

        • latitudenumber

        • longitudenumber

        • namestring

        • timezonestringCan be null

      • latest_quoteobjectCan be null

        8 fields in latest_quote

        • amount_centsinteger

        • currencystring

        • idUUID

        • is_expiredboolean

        • operator_namestringCan be null

        • sent_atdate-timeCan be null

        • statusstring

        • valid_untildate-timeCan be null

      • leg_countinteger

      • legsarray of objects

        12 fields in legs

        • arrive_atdate-timeCan be null

        • depart_datedate

        • depart_timetimeCan be null

        • depart_timezonestringCan be null

        • distance_nminteger

        • fromobject

          10 fields in from

          • citystringCan be null

          • codestring

          • countrystring

          • iatastringCan be null

          • icaostringCan be null

          • idUUID

          • latitudenumber

          • longitudenumber

          • namestring

          • timezonestringCan be null

        • idUUID

        • latest_depart_datedateCan be null

        • paxintegerCan be null

        • seqinteger

        • timezonestring

        • toobject

          10 fields in to

          • citystringCan be null

          • codestring

          • countrystring

          • iatastringCan be null

          • icaostringCan be null

          • idUUID

          • latitudenumber

          • longitudenumber

          • namestring

          • timezonestringCan be null

      • marketplace_publishedboolean

      • marketplace_versioninteger

      • numberinteger

      • parse_statusstringCan be null

        One ofpendingdonefailed

      • paxintegerCan be null

      • preferred_categorystringCan be null

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • quote_countinteger

      • sourcestring

        One ofmanualapiparsedcampaignportalcsv

      • source_systemstringCan be null

      • statusstring

        One ofopenquotedbookedcompleteddeclinedcancelled

      • updated_atdate-time

  • budget_centsintegerCan be null

  • budget_min_centsintegerCan be null

  • campaignobjectCan be null

    2 fields in campaign

    • idUUID

    • subjectstring

  • clientobjectCan be null

    21 fields in client

    • addressobjectCan be null

      The parts of an address. A part the source did not give is null.

      6 fields in address

      • citystringCan be null

      • countrystringCan be null

      • line1stringCan be null

      • line2stringCan be null

      • postal_codestringCan be null

      • regionstringCan be null

    • companystringCan be null

    • consent_recorded_byobjectCan be null

      3 fields in consent_recorded_by

      • avatar_urlstringCan be null

      • display_namestring

      • user_idUUIDCan be null

    • consent_updated_atdate-timeCan be null

    • created_atdate-time

    • emailstringCan be null

    • email_consentboolean

    • idUUID

    • import_batch_idUUIDCan be null

    • last_request_atdate-timeCan be null

    • namestring

    • notesstringCan be null

    • phonestringCan be null

    • preferencesstringCan be null

    • preferred_aircraft_typeobjectCan be null

      5 fields in preferred_aircraft_type

      • categorystring

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • icao_designatorstring

      • idUUID

      • manufacturerstring

      • modelstring

    • preferred_categorystringCan be null

      One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

    • sms_consentboolean

    • tagsarray of strings

    • timezonestring

    • trip_request_countinteger

    • updated_atdate-time

  • created_atdate-time

  • created_byobjectCan be null

    3 fields in created_by

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • currencystring

  • external_trip_idstringCan be null

  • first_legobjectCan be null

    12 fields in first_leg

    • arrive_atdate-timeCan be null

    • depart_datedate

    • depart_timetimeCan be null

    • depart_timezonestringCan be null

    • distance_nminteger

    • fromobject

      10 fields in from

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • idUUID

    • latest_depart_datedateCan be null

    • paxintegerCan be null

    • seqinteger

    • timezonestring

    • toobject

      10 fields in to

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

  • idUUID

  • import_batch_idUUIDCan be null

  • is_staleboolean

  • last_arrivalobjectCan be null

    10 fields in last_arrival

    • citystringCan be null

    • codestring

    • countrystring

    • iatastringCan be null

    • icaostringCan be null

    • idUUID

    • latitudenumber

    • longitudenumber

    • namestring

    • timezonestringCan be null

  • latest_quoteobjectCan be null

    8 fields in latest_quote

    • amount_centsinteger

    • currencystring

    • idUUID

    • is_expiredboolean

    • operator_namestringCan be null

    • sent_atdate-timeCan be null

    • statusstring

    • valid_untildate-timeCan be null

  • leg_countinteger

  • legsarray of objects

    12 fields in legs

    • arrive_atdate-timeCan be null

    • depart_datedate

    • depart_timetimeCan be null

    • depart_timezonestringCan be null

    • distance_nminteger

    • fromobject

      10 fields in from

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • idUUID

    • latest_depart_datedateCan be null

    • paxintegerCan be null

    • seqinteger

    • timezonestring

    • toobject

      10 fields in to

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

  • marketplace_publishedboolean

  • marketplace_versioninteger

  • notesstringCan be null

  • numberinteger

  • operationsobject

    How the trip is flown: the tail and crew, the checklist, the FBO at each end of a leg, what is arranged there, and each leg's flight time at the tail's speed (or the category's average when no tail is chosen), in the legs' order.

    7 fields in operations

    • aircraftobjectCan be null

      3 fields in aircraft

      • idUUID

      • registrationstring

      • typeobjectCan be null

        5 fields in type

        • categorystring

          One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

        • icao_designatorstring

        • idUUID

        • manufacturerstring

        • modelstring

    • checksarray of objects

      3 fields in checks

      • done_atdate-time

      • done_byobjectCan be null

        3 fields in done_by

        • avatar_urlstringCan be null

        • display_namestring

        • user_idUUIDCan be null

      • itemstring

        One oftrip_sheetaircraftcrewmanifestweight_balanceweathernotes

    • flight_minutesarray of integers

    • picobjectCan be null

      2 fields in pic

      • idUUID

      • namestring

    • servicesarray of objects

      11 fields in services

      • confirmationstringCan be null

      • created_atdate-time

      • idUUID

      • kindstring

        One ofcateringhotelground_transportfuelgpulavatoryparking

      • notesstringCan be null

      • seqinteger

      • service_timetimeCan be null

      • sidestring

        One ofdeparturearrival

      • statusstring

        One ofrequestedconfirmed

      • updated_atdate-time

      • vendorstring

    • sicobjectCan be null

      2 fields in sic

      • idUUID

      • namestring

    • stopsarray of objects

      4 fields in stops

      • fboobject

        8 fields in fbo

        • airportobject

          10 fields in airport

          • citystringCan be null

          • codestring

          • countrystring

          • iatastringCan be null

          • icaostringCan be null

          • idUUID

          • latitudenumber

          • longitudenumber

          • namestring

          • timezonestringCan be null

        • emailstringCan be null

        • fuel_brandsarray of stringsCan be null

        • hoursstringCan be null

        • idUUID

        • namestring

        • phonestringCan be null

        • websitestringCan be null

      • seqinteger

      • sidestring

        One ofdeparturearrival

      • statusstring

        One ofrequestedconfirmed

  • parse_notesstringCan be null

  • parse_statusstringCan be null

    One ofpendingdonefailed

  • parsed_fieldsarray of strings

  • paxintegerCan be null

  • preferred_categorystringCan be null

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • quote_countinteger

  • quotesarray of objects

    22 fields in quotes

    • aircraftobjectCan be null

      3 fields in aircraft

      • idUUID

      • registrationstring

      • typeobjectCan be null

        5 fields in type

        • categorystring

          One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

        • icao_designatorstring

        • idUUID

        • manufacturerstring

        • modelstring

    • aircraft_typeobjectCan be null

      5 fields in aircraft_type

      • categorystring

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • icao_designatorstring

      • idUUID

      • manufacturerstring

      • modelstring

    • amount_centsinteger

    • created_atdate-time

    • created_byobjectCan be null

      3 fields in created_by

      • avatar_urlstringCan be null

      • display_namestring

      • user_idUUIDCan be null

    • currencystring

    • idUUID

    • is_expiredboolean

    • line_itemsarray of objectsCan be null

      5 fields in line_items

      • amount_centsinteger

      • kindstring

        One ofaircraft_timecrew_dayovernightcateringground_transporttaxes_feescustom

      • labelstring

      • quantitynumber

      • rate_centsinteger

    • notesstringCan be null

    • operatorobjectCan be null

      4 fields in operator

      • dba_namestringCan be null

      • designatorstring

      • idUUID

      • legal_namestring

    • responded_atdate-timeCan be null

    • responder_namestringCan be null

    • response_notestringCan be null

    • sent_atdate-timeCan be null

    • shared_atdate-timeCan be null

    • sourcestring

    • statusstring

    • trip_request_idUUID

    • updated_atdate-time

    • valid_untildate-timeCan be null

    • viewed_atdate-timeCan be null

  • raw_textstringCan be null

  • sourcestring

    One ofmanualapiparsedcampaignportalcsv

  • source_systemstringCan be null

  • statusstring

    One ofopenquotedbookedcompleteddeclinedcancelled

  • updated_atdate-time

Parsed draft

  • assigned_toUUIDCan be null

  • budget_centsintegerCan be null

  • budget_min_centsintegerCan be null

  • client_idUUIDCan be null

  • legsarray of objects

    5 fields in legs

    • depart_datedateCan be null

    • depart_timetimeCan be null

    • fromstringCan be null

    • latest_depart_datedateCan be null

    • tostringCan be null

  • notesstringCan be null

  • parsed_fieldsarray of strings

  • paxintegerCan be null

  • preferred_categorystringCan be null

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • requesterobjectCan be null

    2 fields in requester

    • emailstringCan be null

    • namestringCan be null

  • unsurearray of strings

Pipeline summary

  • booked_this_monthinteger

  • currencystring

  • open_countinteger

  • open_pipeline_centsinteger

  • quote_to_book_ratenumberCan be null

  • quote_to_book_rate_previousnumberCan be null

  • quoted_countinteger

  • stale_countinteger

  • weeklyarray of objects

    3 fields in weekly

    • bookedinteger

    • createdinteger

    • week_startdate

Trip event

  • actorobjectCan be null

    3 fields in actor

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • actor_kindstring

    One ofpersonkeyclientoperatorsystem

  • atdate-time

  • detailobject

  • idUUID

  • kindstring

    One ofcreatededitedparsedassignedstatus_changedquote_addedquote_sentquote_acceptedquote_declinedquote_sharedproposal_viewedproposal_answeredbooking_completedbooking_cancelledrfq_sentrfq_viewedrfq_answeredrfq_withdrawnrfq_messagecampaign_requesteditinerary_shareditinerary_viewed

Trip note

  • atdate-time

  • authorobjectCan be null

    3 fields in author

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • author_kindstring

    One ofpersonkey

  • bodystring

  • idUUID

Quote

  • aircraftobjectCan be null

    3 fields in aircraft

    • idUUID

    • registrationstring

    • typeobjectCan be null

      5 fields in type

      • categorystring

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • icao_designatorstring

      • idUUID

      • manufacturerstring

      • modelstring

  • aircraft_typeobjectCan be null

    5 fields in aircraft_type

    • categorystring

      One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

    • icao_designatorstring

    • idUUID

    • manufacturerstring

    • modelstring

  • amount_centsinteger

  • created_atdate-time

  • created_byobjectCan be null

    3 fields in created_by

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • currencystring

  • idUUID

  • is_expiredboolean

  • line_itemsarray of objectsCan be null

    5 fields in line_items

    • amount_centsinteger

    • kindstring

      One ofaircraft_timecrew_dayovernightcateringground_transporttaxes_feescustom

    • labelstring

    • quantitynumber

    • rate_centsinteger

  • notesstringCan be null

  • operatorobjectCan be null

    4 fields in operator

    • dba_namestringCan be null

    • designatorstring

    • idUUID

    • legal_namestring

  • responded_atdate-timeCan be null

  • responder_namestringCan be null

  • response_notestringCan be null

  • sent_atdate-timeCan be null

  • shared_atdate-timeCan be null

  • sourcestring

  • statusstring

  • trip_request_idUUID

  • updated_atdate-time

  • valid_untildate-timeCan be null

  • viewed_atdate-timeCan be null

Quote listed

  • aircraftobjectCan be null

    3 fields in aircraft

    • idUUID

    • registrationstring

    • typeobjectCan be null

      5 fields in type

      • categorystring

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • icao_designatorstring

      • idUUID

      • manufacturerstring

      • modelstring

  • aircraft_typeobjectCan be null

    5 fields in aircraft_type

    • categorystring

      One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

    • icao_designatorstring

    • idUUID

    • manufacturerstring

    • modelstring

  • amount_centsinteger

  • created_atdate-time

  • created_byobjectCan be null

    3 fields in created_by

    • avatar_urlstringCan be null

    • display_namestring

    • user_idUUIDCan be null

  • currencystring

  • idUUID

  • is_expiredboolean

  • line_itemsarray of objectsCan be null

    5 fields in line_items

    • amount_centsinteger

    • kindstring

      One ofaircraft_timecrew_dayovernightcateringground_transporttaxes_feescustom

    • labelstring

    • quantitynumber

    • rate_centsinteger

  • notesstringCan be null

  • operatorobjectCan be null

    4 fields in operator

    • dba_namestringCan be null

    • designatorstring

    • idUUID

    • legal_namestring

  • responded_atdate-timeCan be null

  • responder_namestringCan be null

  • response_notestringCan be null

  • sent_atdate-timeCan be null

  • shared_atdate-timeCan be null

  • sourcestring

  • statusstring

  • tripobject

    The request a listed quote is for: enough to name it and open it.

    8 fields in trip

    • arrivalobjectCan be null

      10 fields in arrival

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • clientobjectCan be null

      4 fields in client

      • companystringCan be null

      • idUUID

      • namestring

      • timezonestring

    • depart_datedateCan be null

    • departureobjectCan be null

      10 fields in departure

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • idUUID

    • leg_countinteger

    • numberinteger

    • statusstring

      One ofopenquotedbookedcompleteddeclinedcancelled

  • trip_request_idUUID

  • updated_atdate-time

  • valid_untildate-timeCan be null

  • viewed_atdate-timeCan be null

Booking

  • confirmed_atdate-time

  • idUUID

  • itinerary_shared_atdate-timeCan be null

  • itinerary_viewed_atdate-timeCan be null

  • notesstringCan be null

  • quoteobject

    22 fields in quote

    • aircraftobjectCan be null

      3 fields in aircraft

      • idUUID

      • registrationstring

      • typeobjectCan be null

        5 fields in type

        • categorystring

          One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

        • icao_designatorstring

        • idUUID

        • manufacturerstring

        • modelstring

    • aircraft_typeobjectCan be null

      5 fields in aircraft_type

      • categorystring

        One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

      • icao_designatorstring

      • idUUID

      • manufacturerstring

      • modelstring

    • amount_centsinteger

    • created_atdate-time

    • created_byobjectCan be null

      3 fields in created_by

      • avatar_urlstringCan be null

      • display_namestring

      • user_idUUIDCan be null

    • currencystring

    • idUUID

    • is_expiredboolean

    • line_itemsarray of objectsCan be null

      5 fields in line_items

      • amount_centsinteger

      • kindstring

        One ofaircraft_timecrew_dayovernightcateringground_transporttaxes_feescustom

      • labelstring

      • quantitynumber

      • rate_centsinteger

    • notesstringCan be null

    • operatorobjectCan be null

      4 fields in operator

      • dba_namestringCan be null

      • designatorstring

      • idUUID

      • legal_namestring

    • responded_atdate-timeCan be null

    • responder_namestringCan be null

    • response_notestringCan be null

    • sent_atdate-timeCan be null

    • shared_atdate-timeCan be null

    • sourcestring

    • statusstring

    • trip_request_idUUID

    • updated_atdate-time

    • valid_untildate-timeCan be null

    • viewed_atdate-timeCan be null

  • referencestring

  • statusstring

  • trip_requestobjectCan be null

    27 fields in trip_request

    • assigned_toobjectCan be null

      3 fields in assigned_to

      • avatar_urlstringCan be null

      • display_namestring

      • user_idUUIDCan be null

    • bookingobjectCan be null

      5 fields in booking

      • idUUID

      • itinerary_shared_atdate-timeCan be null

      • itinerary_viewed_atdate-timeCan be null

      • referencestring

      • statusstring

    • budget_centsintegerCan be null

    • budget_min_centsintegerCan be null

    • clientobjectCan be null

      4 fields in client

      • companystringCan be null

      • idUUID

      • namestring

      • timezonestring

    • created_atdate-time

    • currencystring

    • external_trip_idstringCan be null

    • first_legobjectCan be null

      12 fields in first_leg

      • arrive_atdate-timeCan be null

      • depart_datedate

      • depart_timetimeCan be null

      • depart_timezonestringCan be null

      • distance_nminteger

      • fromobject

        10 fields in from

        • citystringCan be null

        • codestring

        • countrystring

        • iatastringCan be null

        • icaostringCan be null

        • idUUID

        • latitudenumber

        • longitudenumber

        • namestring

        • timezonestringCan be null

      • idUUID

      • latest_depart_datedateCan be null

      • paxintegerCan be null

      • seqinteger

      • timezonestring

      • toobject

        10 fields in to

        • citystringCan be null

        • codestring

        • countrystring

        • iatastringCan be null

        • icaostringCan be null

        • idUUID

        • latitudenumber

        • longitudenumber

        • namestring

        • timezonestringCan be null

    • idUUID

    • import_batch_idUUIDCan be null

    • is_staleboolean

    • last_arrivalobjectCan be null

      10 fields in last_arrival

      • citystringCan be null

      • codestring

      • countrystring

      • iatastringCan be null

      • icaostringCan be null

      • idUUID

      • latitudenumber

      • longitudenumber

      • namestring

      • timezonestringCan be null

    • latest_quoteobjectCan be null

      8 fields in latest_quote

      • amount_centsinteger

      • currencystring

      • idUUID

      • is_expiredboolean

      • operator_namestringCan be null

      • sent_atdate-timeCan be null

      • statusstring

      • valid_untildate-timeCan be null

    • leg_countinteger

    • legsarray of objects

      12 fields in legs

      • arrive_atdate-timeCan be null

      • depart_datedate

      • depart_timetimeCan be null

      • depart_timezonestringCan be null

      • distance_nminteger

      • fromobject

        10 fields in from

        • citystringCan be null

        • codestring

        • countrystring

        • iatastringCan be null

        • icaostringCan be null

        • idUUID

        • latitudenumber

        • longitudenumber

        • namestring

        • timezonestringCan be null

      • idUUID

      • latest_depart_datedateCan be null

      • paxintegerCan be null

      • seqinteger

      • timezonestring

      • toobject

        10 fields in to

        • citystringCan be null

        • codestring

        • countrystring

        • iatastringCan be null

        • icaostringCan be null

        • idUUID

        • latitudenumber

        • longitudenumber

        • namestring

        • timezonestringCan be null

    • marketplace_publishedboolean

    • marketplace_versioninteger

    • numberinteger

    • parse_statusstringCan be null

      One ofpendingdonefailed

    • paxintegerCan be null

    • preferred_categorystringCan be null

      One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

    • quote_countinteger

    • sourcestring

      One ofmanualapiparsedcampaignportalcsv

    • source_systemstringCan be null

    • statusstring

      One ofopenquotedbookedcompleteddeclinedcancelled

    • updated_atdate-time