You can now access Rental Agreement information through our API, MCP, and Webhooks, giving you more ways to retrieve agreement details and check signing statuses.
This has been a frequently requested improvement from our Community, and we're happy to make it available!
What's new?
1. Access Rental Agreement details
Reservations now include Rental Agreement summaries with:
-
Agreement name
-
Agreement ID
-
Signing status (signed or unsigned)
These summaries are automatically available through personal access tokens and to API vendors. They don't include filled fields or agreement content.
If you're using a personal access token, you can also retrieve more detailed information through a separate API endpoint, including:
-
Filled fields
-
Agreement content with filled information
-
PDF download URL
2. Search for Rental Agreements
The new /agreements endpoint lets you search for Rental Agreement summaries by reservation or signing status.
3. Rental Agreement updates through Webhooks
Reservation Webhooks now include Rental Agreement summaries when an agreement is created or signed.
For now, Webhooks don't include filled fields. These can be retrieved through the dedicated API endpoint.
--
GET /reservations docs: https://developer.hospitable.com/docs/public-api-docs/ih7nc1ovefrcs-get-reservations
GET /agreements docs: https://developer.hospitable.com/docs/public-api-docs/pla1731~2Dget~2Dagreements-get-agreements
GET /agreements/{id} docs: https://developer.hospitable.com/docs/public-api-docs/pla1731~2Dget~2Dagreement-get-agreement
Webhook docs: https://developer.hospitable.com/docs/public-api-docs/0c89462f0c6f5-receive-reservation-post
--
Let us know what you think.
