API Reference

REST API

Programmatic access to your data rooms, documents, and analytics. Available on the Business plan.

Authentication

All API requests require an API key. You can generate API keys from your account settings at /settings/api-keys.

Include your API key in the Authorization header:

Authorization: Bearer your-api-key

Base URL

https://vdr.h1.io/api/v1

Endpoints

GET

/api/v1/datarooms

List all data rooms for the authenticated team

GET

/api/v1/datarooms/:id

Get details for a specific data room

GET

/api/v1/datarooms/:id/documents

List all documents in a data room

GET

/api/v1/datarooms/:id/links

List all share links for a data room

GET

/api/v1/datarooms/:id/analytics

Get engagement analytics for a data room

GET

/api/v1/datarooms/:id/activity

Get the activity log for a data room

Response format

All responses are returned as JSON. Successful responses return a 200 status code. Errors return appropriate HTTP status codes with an error message.

// Success

{

"data": [...],

"total": 42

}

// Error

{

"error": "Unauthorized"

}

Rate limits

API requests are rate-limited to 100 requests per minute per API key. If you exceed this limit, you'll receive a 429 Too Many Requests response. Contact us if you need higher limits.