Skip to main content

Get Booking Agreement

Return the rental agreement for a booking. If the booking has never had one, it is created from the supplier's template โ€” with that booking's details merged in โ€” and returned.

GET /v1/bookings/{id}/agreement

Authenticationโ€‹

Requires a valid API key with agreements:read scope.

Path Parametersโ€‹

ParameterTypeDescription
idintegerBooking ID

Request Exampleโ€‹

curl "https://app.equipdash.com/api/v1/bookings/4821/agreement" \
-H "Authorization: Bearer YOUR_API_KEY"

Responseโ€‹

{
"data": {
"booking_id": 4821,
"title": "Rental Agreement",
"status": "draft",
"status_label": "Not signed",
"signing_url": "https://app.equipdash.com/agreement/AbCโ€ฆ",
"sent_at": null,
"send_count": 0,
"viewed_at": null,
"signed_at": null,
"signed_name": null,
"signed_ip": null,
"signed_via": null,
"terms": "This agreement is between Example Outfitters and Jane Doe โ€ฆ"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-08-14T09:00:00+00:00"
}
}
signing_url needs write access

The signing link is the whole authorization to sign, so it is only returned to a key that holds agreements:write. With agreements:read alone the response is identical but signing_url is null.

Errorsโ€‹

StatusCodeWhen
403agreements_disabledThe business has rental agreements switched off
409agreement_not_applicableThe booking has no rental items, so it has no agreement
404resource_not_foundNo booking with that ID belongs to this API key's business