VantageKitVantageKit Docs

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.

GET
/deal-rooms/{id}/links

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/links"
{
  "data": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "name": "Investor Link",
      "shortId": "abc123",
      "url": "https://app.vantagekit.com/v/abc123",
      "isActive": true,
      "requiresEmail": true,
      "requiresPassword": false,
      "expiresAt": null,
      "totalClicks": 47,
      "createdAt": "2026-03-15T14:00:00Z"
    }
  ],
  "meta": {
    "apiVersion": "2026-04-01",
    "pagination": {
      "page": 1,
      "perPage": 20,
      "total": 2,
      "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"
}

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.

List viewers

Returns a paginated list of unique viewers for a deal room with aggregated engagement data. Viewers are sorted by most recent view. Each viewer profile includes total views, time spent, and documents viewed.