API Integration
The API Integration lets vendors pull their Leads(website visitors) who viewed the vendor's profile on Software Finder, directly into their own CRM. Instead of manually exporting leads from the Vendor Portal, vendors can generate API key and use a single REST endpoint to retrieve a paginated list of leads. The endpoint supports date-range filters, keyword search, and pagination controls for more targeted data retrieval.
Once an API key is generated, you can access an interactive, self-service documentation page directly from the Vendor Portal. The page includes an Authentication panel, auto-generated code samples in five languages, and a built-in API client (Test Request), so you can authorize the key and fetch live lead data without writing any code.
Integration is a paid plan feature. Upgrade and start accessing your lead data through API Integration.
Generate an API Key
The API key is generated from the Vendor Portal and is specific to your selected profile. The key is required for every request made to the API Integration.
- Log in to the Vendor Portal and open the required profile.
- Go to API Integration from the profile settings.
- Click Generate API Key. Select its expiry from the dropdown options and click Create Key
If a key already exists, the button may appear as Regenerate API Key.
- Copy the API key immediately and store it securely. The key is displayed only once.
Do not share the API key publicly. Treat it as a password for the selected profile.
- Open the API Integration API documentation to authenticate and test the endpoint.
Authenticate the API Documentation
After opening the API documentation, you can enter the key in the Authentication panel displayed on the right side of the page.
- Locate the Authentication panel on the right side.
- Confirm that the authentication scheme is crm-api-key.
- Paste the generated key into the Value field for x-crm-api-key.
- The API documentation will use this key when you test the leads endpoint.
Test the Leads Endpoint
The List profile view leads endpoint returns leads that viewed your profile. A paid plan subscription or trial is required.
- Open Leads from the left navigation and select List profile view leads.
- Review the request endpoint: GET /api/v1/integrations/crm/leads.
- Click Test Request to open the API client.
- Verify that the request returns a 200 OK response and displays the leads data.
Test the Request in the API Client
The API client lets you enter authentication and query parameters in a form and view the response without writing code.
- In the Authentication Required section, paste the API key into the Value field.
- Confirm that the x-crm-api-key header is enabled.
- Select a Date Range and enter any optional search or pagination values.
- Click Send at the top of the client.
- Review the returned data in the Body panel on the right.
The button in the API client is labeled Send. The Test Request button opens to the client where the request can be submitted.
Request Details
| Method | GET |
|---|---|
| Endpoint | /api/v1/integrations/crm/leads |
| Authentication Header | x-crm-api-key: <your-product-api-key> |
Query Parameters
| Parameter | Requirement | Description |
|---|---|---|
| Date Range | Optional | Filters leads by time. Available values: 7 days, 30 days, 60 days, 90 days, and all time. |
| Search | Optional | Searches lead by name, company, or email. |
| Page size | Optional | Sets the number of records returned on each page. |
| Page | Optional | Select the results page to retrieve. |
Responses
- 200 - Request completed successfully. The response contains a paginated list of profile-view leads.
- 401 - The x-crm-api-key header is missing, or the API key is invalid.
- 429 - The rate limit has been exceeded.
Rate Limits
- 60 requests per minute are allowed for each product API key.
- 429 Too Many Requests are returned when the limit is exceeded.
FAQs
Where can I generate the API key?
Generate it from the API Integration section of the selected product in the Vendor Portal.
Why am I receiving a 401 response?
Confirm that the key is correct and is sent in the x-crm-api-key header. Also make sure you are using the key generated for the same product.
Why am I receiving a 429 response?
The product API key has exceeded the limit of 60 requests per minute. Wait briefly before sending more requests.
Can I filter the returned leads?
Yes. Use date range to filter by time, search to find a lead by name, company, or email, and page Size.