Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mapping.travel/llms.txt

Use this file to discover all available pages before exploring further.

The export format configuration determines the structure, encoding, and field selection of mapping result files delivered to your organization. Each organization has a single active format configuration. You can create or replace it using the PUT endpoint at any time, and retrieve the current configuration with GET.
Both endpoints require authentication. Include your bearer token in the Authorization header.

​
PUT /api/v1/export-format

Create or replace your organization’s export format configuration. If no configuration exists, one is created. If one already exists, it is fully replaced by the new values. 
PUT https://api.mapping.travel/api/v1/export-format
Content-Type: application/json

​
Request body

​
format
string
required
Output file format. Accepted values: json, csv, jsonl.
​
includeFields
string[]
List of fields to include in the export. When omitted, all fields are included by default.
​
delimiter
string
default:","
Column delimiter for CSV exports. Ignored for JSON and JSONL formats.
​
includeHeader
boolean
default:"true"
Whether to include a header row in CSV exports.
​
compression
string
Optional compression for the export file. Accepted values: gzip, none. Defaults to none.

​
Response

Returns the saved configuration.
​
id
string
required
UUID of the format configuration.
​
format
string
required
The configured output format.
​
includeFields
string[]
Fields included in the export.
​
delimiter
string
CSV delimiter character.
​
includeHeader
boolean
Whether CSV exports include a header row.
​
compression
string
Compression applied to the export file.
​
updatedAt
string
required
ISO 8601 timestamp of the last update.

​
Example

curl -X PUT https://api.mapping.travel/api/v1/export-format \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "jsonl",
    "compression": "gzip",
    "includeFields": ["referenceId", "supplierId", "supplierHotelId", "confidence"]
  }'

{
  "id": "fmt-2c3d4e5f-0000-0000-0000-000000000001",
  "format": "jsonl",
  "includeFields": ["referenceId", "supplierId", "supplierHotelId", "confidence"],
  "compression": "gzip",
  "updatedAt": "2026-04-25T12:00:00Z"
}

​
GET /api/v1/export-format

Retrieve your organization’s current export format configuration. 
GET https://api.mapping.travel/api/v1/export-format

​
Response

Returns the current format configuration object if one has been set.
​
id
string
required
UUID of the format configuration.
​
format
string
required
Output file format (json, csv, or jsonl).
​
includeFields
string[]
Fields included in the export, if configured.
​
delimiter
string
CSV column delimiter.
​
includeHeader
boolean
Whether CSV exports include a header row.
​
compression
string
Compression type applied to export files.
​
updatedAt
string
required
ISO 8601 timestamp of the last configuration update.

​
Errors

StatusDescription
404 Not FoundNo export format configuration has been set for your organization. Use the PUT endpoint to create one.

​
Example

curl https://api.mapping.travel/api/v1/export-format \
  -H "Authorization: Bearer <token>"