Get the rental agreement link

Returns a link to the reservation's rental agreement document (PDF by default), not the document itself. The link works without API credentials, like the link sent to the customer, so share it only with the customer.

The reservation is looked up by its numeric ID; an unknown ID returns 404.

Responses

🟢200OK

application/json

The document link. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "agreement": "https://yourcompany.example.com/public/car-rental/reservations/email-agreement-pdf?id=5f0b7c3e-2a41-4f9a-9a57-1c2d3e4f5a6b&language=en",
        "has_attachments": false
    }
}

🟠404Record Not Found

Request

Responses