VantageKitVantageKit Docs

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.

GET
/deal-rooms/{id}/documents

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

Query Parameters

page?integer

Page number (1-indexed).

Default1
Range1 <= value
per_page?integer

Items per page (max 100).

Default20
Range1 <= value <= 100

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/documents"
{
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Pitch Deck Q4",
      "displayName": null,
      "sourceType": "pdf",
      "pageCount": 15,
      "status": "published",
      "position": 0,
      "createdAt": "2026-03-10T08:00:00Z",
      "updatedAt": "2026-04-01T12:00:00Z"
    }
  ],
  "meta": {
    "apiVersion": "2026-04-01",
    "pagination": {
      "page": 1,
      "perPage": 20,
      "total": 5,
      "totalPages": 1
    }
  }
}
{
  "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"
}

Get a deal room

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

List links

Returns a paginated list of share links for a deal room, sorted by most recently created. Password hashes are never exposed — only a `requiresPassword` boolean is returned.