---
title: "Document status dashboard"
method: GET
path: "/api/v1/rentals/{rentalId}/documents"
tags: ["Contracts"]
---

# Document status dashboard

`GET /api/v1/rentals/{rentalId}/documents`

## Request

- Base URL: `http://localhost:3002`
- URL: `http://localhost:3002/api/v1/rentals/{rentalId}/documents`
- Auth: HTTP bearer

Returns the status of all documents (contract and waivers) for a rental.

## Path parameters

- `rentalId` string, required

## Response `200`

Document status

- object
  - `data` DocumentStatus
    - `rentalId` string, required
    - `charterAgreement` object, required
      - `required` boolean, required
      - `signed` boolean, required
      - `signerName` string, nullable
      - `signerEmail` string, email, nullable
      - `signedAt` string, date-time, nullable
    - `waivers` object, required
      - `total` integer, required
      - `signed` integer, required
      - `pending` integer, required
      - `guests` Guest[], required
        - `id` string, required
        - `rentalId` string, required
        - `waiverTemplateId` string, nullable
        - `firstName` string, required
        - `lastName` string, required
        - `email` string, email, required
        - `phone` string, nullable
        - `isCharterer` boolean, required
        - `waiverStatus` 'PENDING' | 'SENT' | 'SIGNED', required
        - `waiverSentAt` string, date-time, nullable
        - `waiverSignedAt` string, date-time, nullable
        - `signatureData` string, nullable

## Other responses

- `401`: Unauthorized
- `404`: Rental not found

---

[API](https://skmtc.dev/chartercaptain/apis/charter-captain-api.md) · [All operations](https://skmtc.dev/chartercaptain/apis/charter-captain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chartercaptain/apis/charter-captain-api/revisions/1ffea1113adb?raw)