API - Basic steps for exporting Leads (Postman)

Created by Andre Greiner, Modified on Thu, 2 Mar, 2023 at 8:59 AM by Andre Greiner

Currently in Spotter we have two ways to export Leads: through Spotter directly or via API. In this article, we will deal with exporting Leads via API with Postman (if you don't have it installed, you can download it by clicking here ).  


After downloading, open Postman and click on "Collections" > + > Assign a name to this folder (where the requests will be) > click on the three dots > Add Request:




The first step is to identify the correct documentation, from there we will have the EndPoint to be used. When it comes to using Spotter V2, this is the documentation to be used:  https://exactspotter.docs.apiary.io/#/reference/0/leads-listing


After accessing the documentation, locate in Postman where to insert the EndPoint and Headers:




IMPORTANT:  The Token is found in Spotter by accessing the left side menu "Settings" > Integrations > Token Exact API.


By filling in this form, it is already possible to remove the Spotter Leads. After that, we can use the OData protocol  to filter/sort/etc. To apply a filter by Lead ID, for example, add the key in "Params" and the Id eq value : 




API listings currently have a limitation of 500 Leads per page and the data comes in order from oldest to newest Leads. To remove listing in descending order instead of ascending, use the $orderby parameter:



Another commonly used filter is Source. In this case, the request is made with the $filter key , the value used contains the name of the source, like this:


 

Rate this article so we can improve our service.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article