MagicDoor icon

MagicDoor

Interact with MagicDoor API

Actions36

Company Settings → Get Settings

AI-generated

Overview

This node interacts with the MagicDoor API to retrieve company settings based on a specified company ID and additional optional parameters. It is useful for scenarios where you need to fetch configuration or settings data for a company at various levels such as company, portfolio, property, unit, or lease. For example, it can be used in workflows that require dynamic access to company-specific settings for customization or reporting purposes.

Use Case Examples

  1. Retrieve default settings for a company by providing the company ID.
  2. Fetch settings at the property level by specifying the level and level ID.
  3. Batch retrieve settings for multiple levels using a comma-separated list of level IDs.

Properties

Name Meaning
Company ID The ID of the company for which settings are to be retrieved.
Additional Fields Optional parameters to specify the settings level and corresponding IDs for more granular retrieval of settings.
Request Options Settings to control request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • settings - The retrieved company settings data from the MagicDoor API.

Dependencies

  • MagicDoor API

Troubleshooting

  • Ensure the company ID is valid and exists in the MagicDoor system to avoid errors.
  • If using level-specific settings, verify that the level and level ID(s) are correctly specified.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of security implications.

Links

Discussion