MagicDoor icon

MagicDoor

Interact with MagicDoor API
Join our community

Actions13

Overview

The "Get Companies" operation in the MagicDoor node allows users to retrieve company records from the MagicDoor API based on various filtering criteria. This operation is useful for scenarios where you need to fetch detailed information about companies, such as in CRM integrations, data enrichment workflows, or reporting dashboards.

For example, you might want to:

  • Retrieve companies created within a specific date range.
  • Search for companies by name or phone number.
  • Filter companies by their subdomain URL or custom domain.
  • Get details of specific companies by providing their IDs.

This flexibility enables targeted data retrieval tailored to your business needs.

Properties

Name Meaning
Company IDs Comma-separated list of company IDs to filter by (e.g., "123456789,987654321")
Phone Number Filter companies by phone number (e.g., "+1234567890")
Sub URL Filter companies by subdomain URL (e.g., "example.magicdoor.com")
Custom Domain Filter companies by custom domain (e.g., "example.com")
Search Term Search companies by name or other text fields (e.g., "Company Name")
Created After Filter companies created after this date (date-time input)
Created Before Filter companies created before this date (date-time input)
Onboarded After Filter companies onboarded after this date (date-time input)
Onboarded Before Filter companies onboarded before this date (date-time input)

These properties are grouped under "Additional Fields" and allow fine-grained control over which companies are returned.

Output

The output of this operation is a JSON array of company objects matching the specified filters. Each object typically contains detailed information about a company, such as its ID, name, contact details, domain information, creation and onboarding dates, and other metadata provided by the MagicDoor API.

If the node supports binary data output (not indicated here), it would typically represent attachments or files related to companies, but this operation primarily returns structured JSON data.

Dependencies

  • Requires an active connection to the MagicDoor API.
  • The node must be configured with a valid API key credential for authentication.
  • The base URL for the API is dynamically set from the credentials configuration.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrectly formatted filter values (e.g., invalid date formats or malformed company IDs) may result in empty responses or errors.
    • Network connectivity issues can prevent successful API calls.

  • Error Messages:

    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • Validation errors may occur if filter parameters do not meet expected formats; ensure inputs conform to required types.
    • HTTP status errors are ignored internally but may still affect output; check API response details for troubleshooting.

Links and References

Discussion