# Lightyshare API - [Introduction](https://developers.lightyshare.com/introduction.md): Welcome to the Lightyshare API documentation - [API Keys](https://developers.lightyshare.com/api-keys.md): Learn how to authenticate with the Lightyshare API - [Versioning](https://developers.lightyshare.com/versioning.md): Understanding Lightyshare API versioning strategy - [Changelog](https://developers.lightyshare.com/changelog.md): Changes made to the Lightyshare API worth knowing about - [Rate Limiting](https://developers.lightyshare.com/concepts/rate-limiting.md): Limits applied to the Lightyshare API - [Rentals](https://developers.lightyshare.com/resources/rentals.md): Handle a rental request from start to finish - [Messaging](https://developers.lightyshare.com/resources/messaging.md): Read and answer your conversations - [Options and services](https://developers.lightyshare.com/resources/options-services.md): Manage listings, options, unavailabilities and services - [Webhooks](https://developers.lightyshare.com/resources/webhooks.md): Be told when something happens - [Products](https://developers.lightyshare.com/resources/products.md): Learn how to create, update, and manage products in the Lightyshare API - [Bundles](https://developers.lightyshare.com/resources/bundles.md): Learn how to create and manage product bundles in the Lightyshare API - [Creating Products](https://developers.lightyshare.com/examples/create-product.md): Step-by-step tutorial for creating products in the Lightyshare API - [Error Handling](https://developers.lightyshare.com/examples/error-handling.md): Comprehensive guide to handling errors in the Lightyshare API - [Introduction](https://developers.lightyshare.com/api-reference/introduction.md): Lightyshare API for client integrations - [Get a rental](https://developers.lightyshare.com/api-reference/rentals/get-a-rental.md): Returns rental details if the authenticated user is the tenant or owner - [List rental requests](https://developers.lightyshare.com/api-reference/rentals/list-rental-requests.md): Permission: rental:read - [Get a rental in full](https://developers.lightyshare.com/api-reference/rentals/get-a-rental-in-full.md): Permission: rental:read - [Accept a request](https://developers.lightyshare.com/api-reference/rentals/accept-a-request.md): Permission: rental:decide - [Refuse a request. Answers 409 already_accepted on an accepted rental](https://developers.lightyshare.com/api-reference/rentals/refuse-a-request-answers-409-already_accepted-on-an-accepted-rental.md): Permission: rental:decide - [Consequences of a cancellation](https://developers.lightyshare.com/api-reference/rentals/consequences-of-a-cancellation.md): Permission: rental:cancel - [Cancel an accepted rental. Idempotency-Key required](https://developers.lightyshare.com/api-reference/rentals/cancel-an-accepted-rental-idempotency-key-required.md): Permission: rental:cancel - [Equipment that can be added](https://developers.lightyshare.com/api-reference/rentals/equipment-that-can-be-added.md): Permission: rental:modify - [Preview a modification](https://developers.lightyshare.com/api-reference/rentals/preview-a-modification.md): Permission: rental:modify - [Propose a modification. Idempotency-Key required](https://developers.lightyshare.com/api-reference/rentals/propose-a-modification-idempotency-key-required.md): Permission: rental:modify - [Withdraw a pending modification](https://developers.lightyshare.com/api-reference/rentals/withdraw-a-pending-modification.md): Permission: rental:modify - [Get a product](https://developers.lightyshare.com/api-reference/products/get-a-product.md): Returns product details belonging to the authenticated user - [Update a product](https://developers.lightyshare.com/api-reference/products/update-a-product.md): Updates a product belonging to the authenticated user - [Create a product](https://developers.lightyshare.com/api-reference/products/create-a-product.md): Creates a new product for the authenticated user - [List listings](https://developers.lightyshare.com/api-reference/products/list-listings.md): Permission: product:read - [Archive a listing](https://developers.lightyshare.com/api-reference/products/archive-a-listing.md): Permission: product:write - [Restore a listing](https://developers.lightyshare.com/api-reference/products/restore-a-listing.md): Permission: product:write - [Publish a listing](https://developers.lightyshare.com/api-reference/products/publish-a-listing.md): Permission: product:write - [Unpublish a listing](https://developers.lightyshare.com/api-reference/products/unpublish-a-listing.md): Permission: product:write - [List unavailabilities](https://developers.lightyshare.com/api-reference/products/list-unavailabilities.md): Permission: product:read - [Add an unavailability](https://developers.lightyshare.com/api-reference/products/add-an-unavailability.md): Permission: product:write - [Remove an unavailability](https://developers.lightyshare.com/api-reference/products/remove-an-unavailability.md): Permission: product:write - [Create a bundle](https://developers.lightyshare.com/api-reference/bundles/create-a-bundle.md): Creates a new bundle (product pack) for the authenticated user - [Write to the tenant of a rental](https://developers.lightyshare.com/api-reference/messaging/write-to-the-tenant-of-a-rental.md): Permission: message:write - [List conversations](https://developers.lightyshare.com/api-reference/messaging/list-conversations.md): Permission: message:read - [Read a conversation, marks nothing as read](https://developers.lightyshare.com/api-reference/messaging/read-a-conversation-marks-nothing-as-read.md): Permission: message:read - [Answer in a conversation](https://developers.lightyshare.com/api-reference/messaging/answer-in-a-conversation.md): Permission: message:write - [Mark a conversation as read](https://developers.lightyshare.com/api-reference/messaging/mark-a-conversation-as-read.md): Permission: message:read - [List saved replies](https://developers.lightyshare.com/api-reference/messaging/list-saved-replies.md): Permission: message:read - [Replace the options of a listing](https://developers.lightyshare.com/api-reference/options/replace-the-options-of-a-listing.md): Permission: product:write. `optionIds` is the complete list; an empty list removes every option. - [List options](https://developers.lightyshare.com/api-reference/options/list-options.md): Permission: product:read - [Create an option](https://developers.lightyshare.com/api-reference/options/create-an-option.md): Permission: product:write - [Update an option](https://developers.lightyshare.com/api-reference/options/update-an-option.md): Permission: product:write - [List services](https://developers.lightyshare.com/api-reference/services/list-services.md): Permission: service:read - [Create a service](https://developers.lightyshare.com/api-reference/services/create-a-service.md): Permission: service:write - [Update a service](https://developers.lightyshare.com/api-reference/services/update-a-service.md): Permission: service:write - [Archive a service](https://developers.lightyshare.com/api-reference/services/archive-a-service.md): Permission: service:write - [Restore a service](https://developers.lightyshare.com/api-reference/services/restore-a-service.md): Permission: service:write - [Turn a service on or off](https://developers.lightyshare.com/api-reference/services/turn-a-service-on-or-off.md): Permission: service:write - [Deposit taken on site](https://developers.lightyshare.com/api-reference/deposit/deposit-taken-on-site.md): Permission: deposit:write - [Deposit back online](https://developers.lightyshare.com/api-reference/deposit/deposit-back-online.md): Permission: deposit:write - [Deposit received](https://developers.lightyshare.com/api-reference/deposit/deposit-received.md): Permission: deposit:write - [Contract state](https://developers.lightyshare.com/api-reference/contracts/contract-state.md): Permission: rental:read. Owner of the rental only. Never carries a signing link: the parties sign on the contract page, with their code. - [Start the departure contract](https://developers.lightyshare.com/api-reference/contracts/start-the-departure-contract.md): Permission: contract:write - [Start the return inspection](https://developers.lightyshare.com/api-reference/contracts/start-the-return-inspection.md): Permission: contract:write - [Signed contract](https://developers.lightyshare.com/api-reference/contracts/signed-contract.md): Permission: rental:read. Owner of the rental only. Answers `application/pdf`, or 404 `pdf_not_ready` until the contract is signed. - [List quotes](https://developers.lightyshare.com/api-reference/quotes/list-quotes.md): Permission: quote:read - [Create a quote](https://developers.lightyshare.com/api-reference/quotes/create-a-quote.md): Permission: quote:write - [Get a quote](https://developers.lightyshare.com/api-reference/quotes/get-a-quote.md): Permission: quote:read - [Update a quote](https://developers.lightyshare.com/api-reference/quotes/update-a-quote.md): Permission: quote:write - [Quote PDF](https://developers.lightyshare.com/api-reference/quotes/quote-pdf.md): Permission: quote:read - [Add a line](https://developers.lightyshare.com/api-reference/quotes/add-a-line.md): Permission: quote:write - [Remove a line](https://developers.lightyshare.com/api-reference/quotes/remove-a-line.md): Permission: quote:write - [Update a line](https://developers.lightyshare.com/api-reference/quotes/update-a-line.md): Permission: quote:write - [Add a service](https://developers.lightyshare.com/api-reference/quotes/add-a-service.md): Permission: quote:write - [Remove a service](https://developers.lightyshare.com/api-reference/quotes/remove-a-service.md): Permission: quote:write - [Send a quote](https://developers.lightyshare.com/api-reference/quotes/send-a-quote.md): Permission: quote:write - [Extend a quote](https://developers.lightyshare.com/api-reference/quotes/extend-a-quote.md): Permission: quote:write - [Cancel a quote](https://developers.lightyshare.com/api-reference/quotes/cancel-a-quote.md): Permission: quote:write - [List payouts](https://developers.lightyshare.com/api-reference/payouts/list-payouts.md): Permission: payout:read - [Get a payout](https://developers.lightyshare.com/api-reference/payouts/get-a-payout.md): Permission: payout:read - [Payout of a rental](https://developers.lightyshare.com/api-reference/payouts/payout-of-a-rental.md): Permission: payout:read - [List webhook endpoints](https://developers.lightyshare.com/api-reference/webhooks/list-webhook-endpoints.md): Permission: webhook:manage - [Create a webhook endpoint](https://developers.lightyshare.com/api-reference/webhooks/create-a-webhook-endpoint.md): Permission: webhook:manage - [Remove a webhook endpoint](https://developers.lightyshare.com/api-reference/webhooks/remove-a-webhook-endpoint.md): Permission: webhook:manage - [Last deliveries](https://developers.lightyshare.com/api-reference/webhooks/last-deliveries.md): Permission: webhook:manage - [Read rental settings](https://developers.lightyshare.com/api-reference/settings/read-rental-settings.md): Permission: settings:write - [Change rental settings](https://developers.lightyshare.com/api-reference/settings/change-rental-settings.md): Permission: settings:write ## OpenAPI Specs - [openapi](/openapi.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.