Skip to main content

Response Formats

All Minimal endpoints — both Auto API and Custom API — return responses in multiple formats out of the box. Pass format= as a query parameter to choose the format. The default is JSON.

GET {yourdomain}/{path}?format=csv
GET {yourdomain}/{path}?version=0.1&format=xml

Supported Formats

FormatQuery paramContent-Type
JSONformat=json or omitapplication/json
XMLformat=xmlapplication/xml
YAMLformat=yamlapplication/x-yaml
CSVformat=csvtext/csv
BSONformat=bsonapplication/bson

Examples

JSON (default)

GET https://your-domain.com/lbl/crm/users/all?version=0.1
[
{ "id": 1, "name": "Alice", "email": "alice@example.com" },
{ "id": 2, "name": "Bob", "email": "bob@example.com" }
]

XML

GET https://your-domain.com/lbl/crm/users/all?version=0.1&format=xml
<?xml version="1.0" encoding="UTF-8"?>
<response>
<row>
<id>1</id>
<name>Alice</name>
<email>alice@example.com</email>
</row>
<row>
<id>2</id>
<name>Bob</name>
<email>bob@example.com</email>
</row>
</response>

YAML

GET https://your-domain.com/lbl/crm/users/all?version=0.1&format=yaml
- id: 1
name: Alice
email: alice@example.com
- id: 2
name: Bob
email: bob@example.com

CSV

GET https://your-domain.com/lbl/crm/users/all?version=0.1&format=csv
id,name,email
1,Alice,alice@example.com
2,Bob,bob@example.com

BSON

GET https://your-domain.com/lbl/crm/users/all?version=0.1&format=bson

Returns binary BSON — use a BSON-capable client or library to deserialize.

LanguageLibrary
JavaScript / Nodebsonnpm install bson
Pythonpymongopip install pymongo
Gogo.mongodb.org/mongo-driver/bson
Javaorg.mongodb.bson

Combining with Other Query Params

format= combines with version=, pagination, and filters in the same query string:

# Custom API — version + format
GET /lbl/crm/users/all?version=0.1&format=csv

# Auto API — filters + pagination + format
GET /auto/api/v1/users?pg=0&ps=20&format=xml

# Auto API — filter + format
GET /auto/api/v1/users?name=Alice&format=yaml

Auto API vs Custom API

format= works identically on both:

API TypeSupported
Auto API✅ All 5 formats
Custom API✅ All 5 formats