--- title: "REST API: Overview & Use Cases" description: Learn how to use the Lemontaps REST API to automatically retrieve contacts and profile data and integrate them into external systems. --- [Skip to content](https://support.lemontaps.com/en/rest-api-overview-use-cases#main-content) - [English](https://support.lemontaps.com/en/rest-api-overview-use-cases) - [Deutsch](https://support.lemontaps.com/de/rest-api-überblick-einsatzmöglichkeiten) English Show submenu for translations ![Lemontaps Logo-Black (1)](https://support.lemontaps.com/hubfs/Lemontaps%20Logo-Black%20(1).svg) - Start - Produkte - Preise - Blog - Unternehmen Open main navigation Close main navigation - Start - Produkte - Preise - Blog - Unternehmen - - [English](https://support.lemontaps.com/en/rest-api-overview-use-cases) - [Deutsch](https://support.lemontaps.com/de/rest-api-überblick-einsatzmöglichkeiten) English Show submenu for translations - [Contact us](mailto:support@lemontaps.com) [Contact us](mailto:support@lemontaps.com) How can we help you? - There are no suggestions because the search field is empty. 1. [Lemontaps Helpdesk](https://support.lemontaps.com/en?hsLang=en) 2. [Integrations](https://support.lemontaps.com/en/integrations?hsLang=en) 3. [Other Integrations](https://support.lemontaps.com/en/integrations?hsLang=en#other-integrations) March 27, 2026 # REST API: Overview & Use Cases With the Lemontaps REST API, you can connect Lemontaps to other systems and automate data exchange. This means you can programmatically retrieve contacts or profile links and transfer them into other tools – without manual exports. --- ### Technical Documentation If you want to start implementing right away, you can find all endpoints, examples, and details here: → [Link to API documentation](https://docs.lemontaps.com/public-api/index.html#de) --- ### What Can You Do with the Lemontaps API? ### 1. Access Captured Contacts You can retrieve all contacts collected by you and your team via Lemontaps. #### Typical Use Cases: - Sync leads into your own CRM system - Process contact data in internal tools - Build automated lead workflows This is especially useful if you use a CRM that does not have a native Lemontaps integration (e.g., outside of Salesforce, HubSpot, Dynamics, Outlook, or Pipedrive). #### Important Notes: - All text fields and custom fields are included - Images and attachments are not transferred (e.g., profile pictures, business card images, signatures, or other file attachments) ### 2. Access Profile Links You can retrieve a user’s profile link via the API based on their account email address. #### Typical Use Cases: - Automatically insert the Lemontaps profile into an email signature - Use profile links in internal systems or portals --- ### Access & Setup To use the API, you need the paid REST API add-on. #### Create an API Key: 1. Open the [Public API Keys](https://lemontaps.com/md/settings/public-api-keys) page 2. Create a new key and assign a name 3. Copy the key immediately (**it is only shown once**) #### Important Notes: - API keys cannot be deleted, only deactivated - Existing keys remain visible even if deactivated --- ### Technical Limitations #### No Webhooks Lemontaps currently does not support webhooks. This means: - New contacts are not pushed automatically - Your system needs to actively fetch data (polling) Typical Approach: - Retrieve data at regular intervals (e.g., once per day) - Process new contacts in your target system - [Central User Management](https://support.lemontaps.com/en/central-user-management?hsLang=en#main-content) - [User Management](https://support.lemontaps.com/en/central-user-management?hsLang=en#user-management) - [Email & Communication](https://support.lemontaps.com/en/central-user-management?hsLang=en#email-communication) - [Roles, Permissions & Approvals](https://support.lemontaps.com/en/central-user-management?hsLang=en#roles-permissions-approvals) - [Manage Profile Content](https://support.lemontaps.com/en/central-user-management?hsLang=en#manage-profile-content) - [Bulk Management & Imports](https://support.lemontaps.com/en/central-user-management?hsLang=en#bulk-management-imports) - [Organization & structure](https://support.lemontaps.com/en/central-user-management?hsLang=en#organization-structure) - [White-Label](https://support.lemontaps.com/en/central-user-management?hsLang=en#white-label) - [Identity & Security](https://support.lemontaps.com/en/central-user-management?hsLang=en#identity-security) - [Integrations](https://support.lemontaps.com/en/integrations?hsLang=en#main-content) - [Identity & User Management](https://support.lemontaps.com/en/integrations?hsLang=en#identity-user-management) - [CRM Integrations](https://support.lemontaps.com/en/integrations?hsLang=en#crm-integrations) - [Other Integrations](https://support.lemontaps.com/en/integrations?hsLang=en#other-integrations) - [Digital Business Card](https://support.lemontaps.com/en/digital-business-card?hsLang=en#main-content) - [Share Digital Business Card](https://support.lemontaps.com/en/digital-business-card?hsLang=en#share-digital-business-card) - [Design & Layout](https://support.lemontaps.com/en/digital-business-card?hsLang=en#design-layout) - [NFC card](https://support.lemontaps.com/en/digital-business-card?hsLang=en#nfc-card) - [Lead capture](https://support.lemontaps.com/en/lead-capture?hsLang=en) - [Email signature](https://support.lemontaps.com/en/email-signature?hsLang=en#main-content) - [Centralized email signatures (Outlook)](https://support.lemontaps.com/en/email-signature?hsLang=en#centralized-email-signatures-outlook) - [Manual email signatures](https://support.lemontaps.com/en/email-signature?hsLang=en#manual-email-signatures) - [Email signature design](https://support.lemontaps.com/en/email-signature?hsLang=en#email-signature-design) - [Paper business card ordering system](https://support.lemontaps.com/en/paper-business-card-ordering-system?hsLang=en) - [Legal & Data Protection](https://support.lemontaps.com/en/legal-data-protection?hsLang=en) - [Troubleshooting & Problem Resolution](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#main-content) - [Login & Access Issues](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#login-access-issues) - [Email signature – issues](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#email-signature-issues) - [Technical Diagnostics](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#technical-diagnostics) - [Feature & Function Issues](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#feature-function-issues) - [Paper Card Ordering System – Issues](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#paper-card-ordering-system-issues) - [NFC & Hardware – Issues](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#nfc-hardware-issues) - [SCIM problems](https://support.lemontaps.com/en/troubleshooting-problem-resolution?hsLang=en#scim-problems) - [Account & Security](https://support.lemontaps.com/en/account-security?hsLang=en#main-content) - [Account Settings](https://support.lemontaps.com/en/account-security?hsLang=en#account-settings) - [Billing & Subscription](https://support.lemontaps.com/en/billing-subscription?hsLang=en#main-content) - [Trial Period & Plans](https://support.lemontaps.com/en/billing-subscription?hsLang=en#trial-period-plans) - [Invoices & Payments](https://support.lemontaps.com/en/billing-subscription?hsLang=en#invoices-payments) - [Licenses & Cancellation](https://support.lemontaps.com/en/billing-subscription?hsLang=en#licenses-cancellation) # Lemon Innovation & Technology GmbH [mailto:support@lemontaps.com](mailto:support@lemontaps.com) Copyright © 2026, Lemon Innovation & Technology GmbH