.png)
Leadsie API
The Leadsie API allows you to automate checks for which customers have granted you access, and what they've granted.
Use Case: Connect your own systems to Leadsie to create powerful, automated workflows.
How to get access to the API
API access is only available for PRO or Enterprise plans. To get set up please do contact us (hi@leadsie.com).
API Key: Once enabled, you will find your API key at https://app.leadsie.com/my/api
API endpoints
For full technical details of the endpoints, see https://app.leadsie.com/api-docs/.
The API supports the following endpoints:
- List Clients: https://app.leadsie.com/api/clients
- Shows a summary list of all the clients who have granted you access through Leadsie
- Client Details: https://app.leadsie.com/api/client/{clientId}
- Shows full details of one client and what they've granted to you.
- Check User Status (DEPRECATED): https://app.leadsie.com/api/checkUserStatus
- Check user status: show details of one client, identified by a custom user ID (see below) - the Client Details call replaces this.
Custom user IDs
You can assign a custom identifier to a user by adding a customUserId as a parameter to the connect request URL (this works for normal request pages and embedded):
?customUserId=SOME_UNIQUE_STRING
The API response shows all customUserId values used for your client, and you can also use the customUserId value as the clientId to retrieve details of one client.
They can also be used in combination with the webhooks to map a customer to your internal systems.