Download Agreement PDF
Return the agreement as a PDF. Once signed, this is the stored signed record — the exact bytes generated at signing, not a fresh render. Before signing it is a live preview with an empty signature box.
GET /v1/bookings/{id}/agreement/pdf
Authentication
Requires a valid API key with agreements:read scope.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | integer | Booking ID |
Request Example
curl "https://app.equipdash.com/api/v1/bookings/4821/agreement/pdf" \
-H "Authorization: Bearer YOUR_API_KEY" \
-o rental-agreement-4821.pdf
Response
200 OK with Content-Type: application/pdf and a Content-Disposition: attachment filename. The body is the raw PDF — not the usual JSON envelope.
The document carries the business header, both parties, the line items with amounts, the terms as signed, the signature image, and the signing log (name, date and time, IP address).
Errors
Errors still return the standard JSON envelope.
| Status | Code | When |
|---|---|---|
403 | agreements_disabled | The business has rental agreements switched off |
409 | agreement_not_applicable | The booking has no rental items, so it has no agreement |
404 | resource_not_found | No booking with that ID belongs to this API key's business |