Actions2
List Companies
AI-generatedOverview
This node interacts with the Warmr API to list companies based on user-defined parameters. It is useful for scenarios where users want to retrieve a paginated list of companies, optionally filtered by a search term. For example, it can be used to fetch companies for display in a dashboard or to process company data in workflows.
Use Case Examples
- Retrieve the first page of companies with 50 results per page.
- Search for companies by name and get the second page of results with 20 companies per page.
Properties
| Name | Meaning |
|---|---|
| Page | The page number of the results to retrieve, used for pagination. |
| Per Page | The number of results to return per page, with a maximum of 100. |
| Search | A search string to filter companies by their name. |
Output
JSON
json- The JSON response containing the list of companies returned by the Warmr API.
Dependencies
- Requires an API key credential for the Warmr API to authenticate requests.
Troubleshooting
- Common issues include invalid or missing API key credentials, which will cause authentication errors.
- If the 'page' or 'perPage' parameters are set to invalid values (e.g., negative numbers or exceeding max limits), the API may return errors or empty results.
- Network or API service issues may cause request failures; ensure the Warmr API service is reachable.
Links
- Warmr API Documentation - Companies - Official API documentation for listing companies via the Warmr API.