VantageKitVantageKit Docs

Get a deal room

Returns a single deal room with detailed summary statistics including unique viewers and average view duration.

GET
/deal-rooms/{id}

Authorization

AuthorizationBearer <token>

Pass your API key as a Bearer token.

Authorization: Bearer vk_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ012345

In: header

Path Parameters

id*string

Deal room UUID.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vantagekit.com/v1/deal-rooms/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Series A Fundraising",
    "description": "Materials for Series A pitch",
    "status": "active",
    "documentCount": 5,
    "linkCount": 2,
    "totalViews": 23,
    "uniqueViewers": 8,
    "avgViewDurationSeconds": 145,
    "createdAt": "2026-03-01T10:00:00Z",
    "updatedAt": "2026-04-08T15:30:00Z"
  },
  "meta": {
    "apiVersion": "2026-04-01"
  }
}
{
  "error": "API key is required",
  "code": "unauthorized"
}
{
  "error": "Deal room not found",
  "code": "not_found"
}
{
  "error": "Rate limit exceeded",
  "code": "rate_limit"
}
{
  "error": "An unexpected error occurred",
  "code": "internal_error"
}

List deal rooms

Returns a paginated list of deal rooms belonging to your team, sorted by most recently updated. Each deal room includes computed counts for documents, links, and total views.

List documents

Returns a paginated list of published documents in a deal room, ordered by their position in the sidebar. Only documents with `status: published` are included.