Actions100
- Activity Logs Actions
- Articles Actions
- Asset Layouts Actions
- Asset Passwords Actions
- Assets Actions
- Get Assets
- Get Companies Company Id Assets
- Post Companies Company Id Assets
- Get Companies Company Id Assets Id
- Put Companies Company Id Assets Id
- Delete Companies Company Id Assets Id
- Put Companies Company Id Assets Id Archive
- Put Companies Company Id Assets Id Unarchive
- Put Companies Company Id Assets Id Move Layout
- Cards Actions
- Companies Actions
- Expirations Actions
- Exports Actions
- Folders Actions
- IP Addresses Actions
- Lists Actions
- Magic Dash Actions
- Matchers Actions
- Networks Actions
- Password Folders Actions
- Procedure Tasks Actions
- Procedures Actions
- Public Photos Actions
- Rack Storage Items Actions
- Rack Storages Actions
- Relations Actions
- Uploads Actions
Overview
The "Get Companies" operation retrieves a list of companies from an external service, supporting various filters and pagination options. This node is useful when you want to fetch company data based on specific criteria such as name, location, or identifiers, enabling integration with CRM systems, business directories, or custom databases.
Practical examples include:
- Fetching all companies located in a particular city or state.
- Retrieving companies updated after a certain date.
- Searching for companies by phone number or website.
- Paginating through large sets of company records.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional filters and pagination controls to refine the list of companies returned. Options include: - Page: Retrieve the specified page of results (number). - Page Size: Number of results per page (number). - Name: Filter companies by name (string). - Phone Number: Filter companies by phone number (string). - Website: Filter companies by website (string). - City: Filter companies by city (string). - Id Number: Filter companies by id_number (string). - State: Filter companies by state (string). - Slug: Filter companies by URL slug (string). - Search: Filter companies by a search query (string). - Id In Integration: Filter companies by id/identifier in external integrations (string). - Updated At: Filter companies updated within a range or at an exact time (string). |
Output
The node outputs JSON data containing the list of companies matching the query parameters. Each item in the output typically represents a company object with its associated fields such as name, contact details, location, identifiers, and other metadata as provided by the external API.
If binary data were supported, it would represent attachments or files related to companies, but this operation focuses on JSON data only.
Dependencies
- Requires an API key or authentication token configured in n8n credentials to access the external service.
- The node depends on the external API endpoint that provides company data.
- Proper base URL configuration is necessary in the credentials to direct requests to the correct API environment.
Troubleshooting
- Empty Results: If no companies are returned, verify that the filter parameters are correct and that the API credentials have sufficient permissions.
- Pagination Issues: Ensure that the
PageandPage Sizeparameters are set correctly; invalid values may cause errors or unexpected results. - Authentication Errors: Check that the API key or authentication token is valid and has not expired.
- Invalid Filter Values: Using unsupported or incorrectly formatted filter values (e.g., date formats for
Updated At) can lead to API errors. - Network or API Downtime: Temporary connectivity issues or API outages will prevent data retrieval; retry after some time.
Links and References
- Refer to the external API documentation for detailed descriptions of each query parameter and response structure.
- Consult n8n documentation on how to configure API credentials and use collection-type input properties.