Search Organizations
AI-generatedOverview
This node operation allows users to search for German companies using the handelsregister.ai API. It supports filtering by search query, postal code, and pagination options such as skip and limit. This is useful for scenarios where users need to find organizations based on partial or full company names, registration numbers, or other search criteria, and want to retrieve a list of matching companies with metadata about the search results.
Use Case Examples
- Searching for companies named 'Konux' with a limit of 10 results per page.
- Filtering search results by postal code to narrow down companies in a specific area.
- Skipping a number of results to paginate through search results.
Properties
| Name | Meaning |
|---|---|
| Query | Search query string to find companies (minimum 2 characters). Used to specify the company name, registration number, or other search terms. |
| Skip | Number of results to skip, used for pagination to offset the starting point of the search results. |
| Limit | Number of results to return per page, with a minimum of 1 and maximum of 100. |
| Postal Code Filter | Filter search results by postal code to restrict companies to a specific geographic area. |
Output
JSON
json- ``
*id- Unique identifier of the organization.
*name- Name of the organization.
*address- Address details of the organization.
*_meta
*total- Total number of matching organizations found in the search.
*request_credit_cost- Credit cost of the search request.
*credits_remaining- Remaining credits available for the API usage.
- ``
Dependencies
- handelsregister.ai API key credential
Troubleshooting
- Ensure the search query has at least 2 characters to avoid validation errors.
- Check API credentials and network connectivity if requests fail.
- If no results are returned, try broadening the search query or removing postal code filters.
- Pagination parameters (skip and limit) should be within valid ranges to avoid errors.
Links
- handelsregister.ai API Documentation - Official API documentation for understanding available endpoints and parameters.