# LettrLabs Public API Documentation LettrLabs Public API Documentation. Version: 1.0.0 ## Servers ``` https://app.lettrlabs.com/api ``` ## Security ### apikey Type: apiKey In: header Name: X-API-KEY ## Download OpenAPI description [LettrLabs Public API Documentation](https://docs.lettrlabs.com/_spec/LettrLabs_API_Reference.yaml) ## Profile ### Validate - [GET /v1/me](https://docs.lettrlabs.com/lettrlabs_api_reference/profile/me.md): Validate your API key. ## Conversions ### Post multiple conversions - [POST /v1/conversions](https://docs.lettrlabs.com/lettrlabs_api_reference/conversions/postconversions.md): Posts multiple conversions with validation. Returns validation information and processes valid records even if some are invalid. ### List all conversions - [GET /v1/conversions](https://docs.lettrlabs.com/lettrlabs_api_reference/conversions/listconversions.md): Retrieves all conversions for the authenticated user ### Delete conversions - [DELETE /v1/conversions/{id}](https://docs.lettrlabs.com/lettrlabs_api_reference/conversions/deleteconversions.md): Marks a specific conversion for deletion by validating its status and preparing for removal. Client must subsequently check deletion status via status endpoint. ### Check the status of a specific conversion - [GET /v1/conversions/{id}/status](https://docs.lettrlabs.com/lettrlabs_api_reference/conversions/checkconversionstatus.md): Returns the processing status of a specified conversion by its ID ## Orders ### Create from Template - [POST /v1/order](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-createorderfromtemplate.md): Create an order using a specified template Id. ### Retrieve - [GET /v1/order](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-getorders.md): Retrieve all orders created by OpenAPI calls. This endpoint does not return orders created on-platform. ### Delete - [DELETE /v1/order/{id}](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-deleteorder.md): Deletes an order that is in draft or edits needs status. ### Proof - [GET /v1/order/{id}/proof/{recipient?}](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-getorderproof.md): Retrieve the auto-generated proof for a specified order in PDF format. The proof contains front, page and envelope (if applicable) pages. ### Analytics - [GET /v1/order/{id}/analytics](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-statistics.md): Retrieve order analytics such as delivery, number of recipients and order status from a given order id. ### Transactions - [GET /v1/order/{id}/transaction](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-transactions.md): Retrieve transaction data from order id. ### Checkout Summary - [GET /v1/order/{id}/checkout](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-calculateordercheckout.md): Calculate and retrieves the line item cost, production and estimated delivery details for a specific order for review prior to executing the checkout. This is not required to be called before executing a checkout. ### Checkout - [POST /v1/order/{id}/checkout](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-postordercheckout.md): Executes the checkout process for a specified order using its unique Order Id. Upon success, credits or payment methods will be charged for the order. To review the cost prior to execution, call Checkout Review. ### Retrieve Recipients - [GET /v1/order/{id}/recipients](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-getrecipientsfromorder.md): Retrieve a list of recipients associated to a specific order. ### Delete Recipients - [DELETE /v1/order/{id}/recipients](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-deleterecipientsfromorder.md): Delete recipients associated with a specific order in draft or edits needed status. ### Add Recipients - [PUT /v1/order/{id}/recipients:append](https://docs.lettrlabs.com/lettrlabs_api_reference/orders/v1-external-orders-appendrecipientstoorder.md): Add recipients to a specified order in draft or edits needed status. Recipients will run through address validation, and the response will return how many are valid. Any recipients that have incomplete addresses will not be added to the order. Define mail-merge, image-merge, return address override, and other metadata at the recipient level. ## Automations ### Retrieve Integration Orders - [GET /v1/integration-orders](https://docs.lettrlabs.com/lettrlabs_api_reference/automations/getintegrationorders.md): Gets all integration orders for the profile. ### Add Recipient - [POST /v1/integration-orders/{id}/recipients](https://docs.lettrlabs.com/lettrlabs_api_reference/automations/postrecipienttointegrationorder.md): Add a recipient into a integration order by Id. If the integration order is Active, recipient will be added to queue to be mailed to. ### Radius Mail - [POST /v1/integration-orders/{id:int}:mail-by-proximity](https://docs.lettrlabs.com/lettrlabs_api_reference/automations/mailbyproximity.md): Initiate a Radius Mail order centered around the list of provided addresses. Each address in the list will initiate a Radius Mailing with the provided filter settings. Recipients will be queried and added to the provided integration order. ## Order Recipient Analytics ### Update QR Scans - [POST /v1/order-recipients-statistics](https://docs.lettrlabs.com/lettrlabs_api_reference/order-recipient-analytics/scanorderrecipientqrcode.md): Updates order recipients statistics when a QR Code is scanned. ## Address Book ### Add Recipient - [POST /v1/zapierActions/address-book](https://docs.lettrlabs.com/lettrlabs_api_reference/address-book/addaddressbookentry.md): Add a new recipient into the address book.