Response Format
Standard response envelope, pagination, and API versioning.
Envelope
Every successful response wraps the result in a consistent envelope:
{
"data": { ... },
"meta": {
"apiVersion": "2026-04-01"
}
}data— The requested resource (object) or resources (array)meta.apiVersion— The API version that generated this response
Pagination
List endpoints return paginated results with a pagination object in meta:
{
"data": [ ... ],
"meta": {
"apiVersion": "2026-04-01",
"pagination": {
"page": 1,
"perPage": 20,
"total": 42,
"totalPages": 3
}
}
}Parameters
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
page | integer | 1 | — | Page number (1-indexed) |
per_page | integer | 20 | 100 | Items per page |
Iterating through pages
async function fetchAllDealRooms(apiKey) {
const results = []
let page = 1
while (true) {
const res = await fetch(
`https://api.vantagekit.com/v1/deal-rooms?page=${page}&per_page=100`,
{ headers: { 'Authorization': `Bearer ${apiKey}` } }
)
const { data, meta } = await res.json()
results.push(...data)
if (page >= meta.pagination.totalPages) break
page++
}
return results
}API versioning
The current API version is 2026-04-01. The version is returned in every response under meta.apiVersion.
When we introduce breaking changes, we'll release a new API version and communicate the changes in the changelog. Previous versions will continue to work for a deprecation period.