Skip to main content
All list endpoints support offset-based pagination via limit and offset query parameters.

Parameters

ParameterTypeDefaultDescription
limitinteger25Number of results to return. Max 100.
offsetinteger0Number of results to skip before returning data.
include_totalbooleantrueWhether to include meta.total in the response.

Response shape

{
  "data": [ ... ],
  "meta": {
    "total": 5634,
    "limit": 25,
    "offset": 0
  }
}
  • meta.total — total number of records matching your filters (before pagination)
  • meta.limit — the applied limit
  • meta.offset — the applied offset

Paging through results

# Page 1 (records 1-25)
curl "https://api.dealroom.co/api/entities?sort=-launch_year&limit=25&offset=0" ...

# Page 2 (records 26-50)
curl "https://api.dealroom.co/api/entities?sort=-launch_year&limit=25&offset=25" ...

# Page 3 (records 51-75)
curl "https://api.dealroom.co/api/entities?sort=-launch_year&limit=25&offset=50" ...

Skipping the total count

For large datasets, computing meta.total adds a small overhead. If you don’t need it (e.g. for infinite scroll), disable it:
curl "https://api.dealroom.co/api/entities?sort=-valuation&limit=25&include_total=false" ...
This returns meta.total as null but eliminates the count query.

Limits

The maximum limit per request is 100. To retrieve more than 100 records, page through results using offset.
If you need to export large datasets (thousands of records), consider using the aggregate endpoints to summarise data instead of paging through raw entities.