Get mandatory trip fields per country

Returns, for each requested destination country, the trip fields that are mandatory when creating a trip there: fields that are always required plus fields made required by a destination-country condition. Fields whose requiredness additionally depends on other field values at trip-creation time are flagged conditionallyRequired with their conditions included. Requiredness driven by compliance workflows or travel policies is not included — it depends on the origin country and traveler, not the destination alone. Fields flagged singleTravelerOnly are hidden on group trips but are still reported mandatory here — this endpoint has no traveler-count input to gate on.

Polling for changes (PROD-1723): pass since to narrow the response to fields touched after that timestamp — store the returned asOf and pass it back as since on your next poll. This is an approximate change feed, not a diff: a field can appear even if a specific country's required/not-required outcome is unaffected (only some other property changed). Deletions of a field or a conditional-requiredness rule leave no trace in since and are not reflected there.

Knowing when to reconcile (PROD-1783): every response also carries an opaque version for your whole mandatory-field configuration. Store it alongside asOf. When version is unchanged, nothing this endpoint reports has changed and no reconcile is needed; when it changes, re-poll without since (passing an explicit countries list, see below) for a full snapshot. Unlike since, version moves on deletions too, so this replaces reconciling blindly on a timer. Compare it for equality only — it is not a timestamp, is not ordered, and is not comparable against the version returned by other endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

ISO 8601 timestamp with an explicit UTC offset, e.g. 2024-06-01T00:00:00Z. Only return fields touched after this time (see asOf on the response). Omit for the full current snapshot (requires an explicit countries list). When countries is also omitted, since cannot be more than 35 days in the past — pass an explicit countries list for an older reconcile.

string
enum

Narrow the returned fields to those relevant to a trip type (e.g. a Workation field is not mandatory for a business trip). Unknown values return the full set.

Allowed:
string

Comma-separated ISO2 destination country codes, e.g. DE,FR. Max 50 per request. Omit only together with since, to poll every country for changes without knowing in advance which one changed — a full snapshot (no since) across every country is not allowed without an explicit list, since it would duplicate every field object per country and risk an oversized response.

Responses

400

Unknown country code, more than 50 explicit countries requested, an invalid since value, countries omitted without since, or since more than 35 days in the past with countries omitted.

429

Rate limit exceeded (max 30 requests per minute).

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json