Skip to main content

API keys

Streamline your workflows with our public API capabilities

Updated today

Enterprise clients across all industries are unlocking new levels of efficiency and operational agility by integrating Virtual Data Room (VDR) technology directly into their IT ecosystems. Seamless API integration empowers organizations to automate workflows, enhance security, and ensure compliance – all while streamlining internal processes and strengthening client relationships.

With robust API integration, enterprises can transform VDR into a seamless, indispensable component of their business operations – driving efficiency, security, and competitive advantage.

Introducing Ideals public API

ℹ️ API is available with Enterprise subscription only as an add-on. Reach out to your account manager for more details.

Our public API empowers enterprise clients to seamlessly integrate VDR capabilities into their existing systems and workflows. Designed for scalability, security, and efficiency, the API unlocks a wide range of use cases – from automating activity logging and enhancing security monitoring to streamlining user and document management.

  • Integrated activity logging: feed your projects activity logs into CRM systems to build comprehensive reports and enrich client profiles with engagement data.

  • Enhanced security monitoring: push all user actions to SIEM platforms for real-time tracking of suspicious activity.

  • Streamlined user management: invite users and manage access permissions programmatically.

  • Efficient document handling: upload or download files to and from external platforms like SharePoint or CRM, supporting cost-effective, long-term storage.

  • Seamless system integration: embed direct links to project documents within internal portals or CRMs, enabling users to access resources with a single click.

  • Automated project creation: launch your project directly from external systems such as ticketing platforms or CRMs.

ℹ️ We are continuously working on enabling more capabilities. As clients onboard and share feedback, new use-cases emerge, ensuring VDR evolves to meet the ever-changing needs of enterprise environments.

Creating API key

API keys are unique credentials that allow secure access to your corporate account’s data. Each API key is tied to a specific user of a corporate account, ensuring that access and actions remain consistent with what a given user is authorized to view and perform within the platform.

⚠️ API keys remain active even if a corporate account participant is deleted, provided they still have valid access to projects. In such cases, the key will continue to generate and receive data.

To ensure the highest level of security, always review and manually remove any API keys associated with deleted participants. This helps prevent unintended access and maintains the integrity of your system.

To get started, using the API keys for your integrations, proceed to your corporate account – API keys.

  • Click Create new key.

  • Enter a key name to help you identify its purpose later.

  • Select when the key should expire:

    • 3 months

    • 6 months

    • 1 year

    • Upon corporate account closure.

  • Click Create.

Once the key is created, a dialog will display the key details, including the secret key string. Make sure you save or copy it for future reference.

⚠️ This is the only time the secret key will be shown. Copy it or download it securely for your API setup.

Using your API key

Use the secret key in your application or integration as instructed in the API documentation. Treat your key like a password – do not share it or expose it in public repositories.

💡 If you need to manage multiple corporate accounts, create a separate API key for each account to ensure secure and independent integration.

Deleting API keys

To delete an existing API key, click Delete next to it, or select multiple keys and click the corresponding option on the top panel.

Once deleted, the keys are no longer displayed in the list. Any integrations associated with the deleted key will stop working.

If you have any questions or need assistance, reach out to support@idealsvdr.com

Did this answer your question?