CharterOpsCharterOps

API reference

Clients

Search, create and update the people and companies you fly.

Search clients

GET/v1/clients

Scope
read
Quota
Counts toward your allowance

Query parameters

  • qstring

    Up to 120 characters.

  • tagstring

  • consentstring

    One ofemailsms

  • last_requeststring

    One oflast_30_dayslast_90_daysover_90_daysnever

  • sortstring

    Defaults to name.

    One ofname-nameemail-emailphone-phonetags-tagstrip_request_count-trip_request_countlast_request_at-last_request_at

  • cursorstring

    Up to 2,000 characters.

  • limitinteger

    From 1 to 100. Defaults to 25.

Response

200 OK

Returns a page of client 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/clients" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Create a client

POST/v1/clients

Scope
write
Quota
Counts toward your allowance

Headers

  • Idempotency-KeystringRequired

    1 to 200 characters.

Request body

  • namestringRequired

    1 to 120 characters.

  • addressobject

    A postal address as Settings writes it. Every marketing email prints it on one line.

    6 fields in address

    • citystringRequired

      1 to 80 characters.

    • countrystringRequired

      Matches ^[A-Z]{2}$.

    • line1stringRequired

      1 to 120 characters.

    • line2string

      1 to 120 characters.

    • postal_codestring

      1 to 20 characters.

    • regionstring

      1 to 80 characters.

  • companystring

    Up to 120 characters.

  • emailemail

  • email_consentboolean

    Defaults to false.

  • notesstring

    Up to 2,000 characters.

  • phonestring

    Up to 40 characters.

  • preferencesstring

    Up to 2,000 characters.

  • preferred_aircraft_type_idUUID

  • preferred_categorystring

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • sms_consentboolean

    Defaults to false.

  • tagsarray of strings

    Each item: 1 to 32 characters.

  • timezonestring

    Up to 64 characters. Defaults to UTC.

Response

201 Created

Returns the client 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/clients" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --header "Idempotency-Key: $(uuidgen)" \
  --json @body.json

Read a client and recent requests

GET/v1/clients/{id}

Scope
read
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Response

200 OK

Returns the client detail 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/clients/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Update a client

PATCH/v1/clients/{id}

Scope
write
Quota
Counts toward your allowance

Path parameters

  • idUUIDRequired

Request body

  • addressobject

    A postal address as Settings writes it. Every marketing email prints it on one line.

    6 fields in address

    • citystringRequired

      1 to 80 characters.

    • countrystringRequired

      Matches ^[A-Z]{2}$.

    • line1stringRequired

      1 to 120 characters.

    • line2string

      1 to 120 characters.

    • postal_codestring

      1 to 20 characters.

    • regionstring

      1 to 80 characters.

  • companystring

    Up to 120 characters.

  • emailemail

  • email_consentboolean

  • namestring

    1 to 120 characters.

  • notesstring

    Up to 2,000 characters.

  • phonestring

    Up to 40 characters.

  • preferencesstring

    Up to 2,000 characters.

  • preferred_aircraft_type_idUUID

  • preferred_categorystring

    One ofpistonturboproplightmidsizesuper_midsizeheavyultra_long_rangehelicopter

  • sms_consentboolean

  • tagsarray of strings

    Each item: 1 to 32 characters.

  • timezonestring

    Up to 64 characters.

Response

200 OK

Returns the client 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/clients/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY" \
  --json @body.json

Delete a client

DELETE/v1/clients/{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/clients/$ID" \
  --header "Authorization: Bearer $CHARTEROPS_API_KEY"

Objects

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

Client detail

  • 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

  • recent_trip_requestsarray of objects

    27 fields in recent_trip_requests

    • 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

  • sms_consentboolean

  • tagsarray of strings

  • timezonestring

  • trip_request_countinteger

  • updated_atdate-time