Retrieving Leads Through REST API?
Updated at: Created at:
This article outlines that leads cannot be retrieved on demand through REST API calls. It goes over the alternative methods you should use to retrieve your lead data instead.
We do not allow clients to retrieve lead data on demand via REST API calls.
You should instead either Export your leads or set up a File schedule delivery to automate the export on a schedule.
We do offer the ability to search for leads via the REST API, however, this requires you to search with an email or phone value.
The full documentation for the https://[ACCOUNT].leadbyte.co.uk/restapi/v1.3/leads/search call can be found on the API KEY page after selecting the lead -> search permission and scrolling down the page.
Alternatively, if you would like to send leads out to an external platform via REST API you could to do this as leads are processed via Webhooks.
Please get in touch with support if you have any questions at all.
Comments