---
title: API Overview
description: Ripple’s Web API (Application Programming Interface) is a powerful tool that allows you to transfer data between Ripple and a third-party system using developer tools or command-line operations. This article provides an overview of how Ripple’s API works and the basic requirements for exporting and importing data efficiently.
---

[Skip to content](https://support.enrollnow.io/en/knowledge-base/curl-api-overview#main-content)

[EnrollNow Support Center](https://support.enrollnow.io/helpdesk?hsLang=en)

![Logo + Tagline](https://support.enrollnow.io/hs-fs/hubfs/EnrollNow/Brand%20Assets/Logo%20+%20Tagline.png?width=300&height=75&name=Logo%20+%20Tagline.png)

- [Support Center](https://support.enrollnow.io/helpdesk)
- [User Community](https://academy.enrollnow.io/)
- [Learning Academy](https://academy.enrollnow.io/)
- [Knowledge Base](https://support.enrollnow.io/en/knowledge-base)

Open main navigation

Close main navigation

- [Support Center](https://support.enrollnow.io/helpdesk)
- [User Community](https://academy.enrollnow.io/)
- [Learning Academy](https://academy.enrollnow.io/)
- [Knowledge Base](https://support.enrollnow.io/en/knowledge-base)
- [EnrollNow Support Center](https://support.enrollnow.io/helpdesk)

 How can we help you?

- There are no suggestions because the search field is empty.

1. [EnrollNow Knowledge Base](https://support.enrollnow.io/en/knowledge-base?hsLang=en)
2. [API](https://support.enrollnow.io/en/knowledge-base/api?hsLang=en)

June 11, 2026

# API Overview

EnrollNow’s Web API (Application Programming Interface) is a powerful tool that allows you to transfer data between EnrollNow and a third-party system using developer tools or command-line operations. This article provides an overview of how EnrollNow’s API works and the basic requirements for exporting and importing data efficiently.

### **What Is the API?**

EnrollNow’s API enables you to automate the transfer of data to and from EnrollNow via your computer’s terminal or command-line interface. It uses HTTP requests to:

- **Export data** from EnrollNow into a CSV file
- **Import data** into EnrollNow from a third-party system

The API is ideal for bulk data transfers and helps eliminate the need for manual entry within the EnrollNow interface. This reduces duplicate work and helps ensure consistency across systems such as:

- Electronic Data Capture (EDC) systems
- Clinical Trial Management Systems (CTMS)
- Customer Relationship Management (CRM) tools

NOTE: The API does **not** enable real-time sync between systems. You must separately run import and export commands for each direction of data transfer.

#### **Permissions and Access to use APIs**

- Only users with **Site Admin** or **Site Manager** roles can use the cURL API.
- You must have permissions for the **study** you're trying to access.
- Each EnrollNow command must include a valid **authorization key.** Refer to this **[article](https://support.enrollnow.io/en/knowledge-base/creating-a-base64-authorization-key-for-api-use?hsLang=en)** on how to create an Authorization Key.

### **Export API**

The Export API allows you to extract data either from the **Registry** or from a **specific study** in EnrollNow.

#### **How It Works:**

- From a command line, or any suitable development tool or script command that specifies:  
    - The data source (Registry or study)
    - The variables you want to export

- - - Your authorization key (created from your sign-in credentials).Each EnrollNow command must include a valid **authorization key.**
    - Execute the command.
- The result will be a downloadable CSV file.
- You can then import this data into your third-party system.

**NOTE:**  You cannot filter the exported data prior to the export. All data for the selected variables will be included in the output file.

### **Import API**

 The Import API allows data from a third-party system to be uploaded into EnrollNow. To import successfully, the data must follow EnrollNow’s Import Tool Data Dictionary format.

#### **How It Works:**

- Format your external data to match EnrollNow’s import requirements to the[Data Dictionary rules.](https://21554971.hs-sites.com/en/knowledge-base/data-dictionary-overview?hsLang=en)
- From a command line, or any suitable development tool or script, write a command that includes:

- - The destination (Registry or a specific study)
    - The formatted data file
    - Your authorization key (created from your sign-in credentials).Each EnrollNow command must include a valid **authorization key.**
- Execute  the command to import the data into EnrollNow.

**NOTE:**  The EnrollNow API does not support the **–compressed** option. We recommend *not* using this option when invoking the API, as it will result in inconsistent and incomplete results. 

 

- [My Account](https://support.enrollnow.io/en/knowledge-base/my-account?hsLang=en#main-content)

    - [Customer Corner](https://support.enrollnow.io/en/knowledge-base/my-account?hsLang=en#customer-corner)
    - [Support](https://support.enrollnow.io/en/knowledge-base/my-account?hsLang=en#support)
- [Users & Permissions](https://support.enrollnow.io/en/knowledge-base/users-permissions?hsLang=en)
- [Registry](https://support.enrollnow.io/en/knowledge-base/registry?hsLang=en)
- [Studies](https://support.enrollnow.io/en/knowledge-base/studies?hsLang=en)
- [Dashboard](https://support.enrollnow.io/en/knowledge-base/dashboard?hsLang=en)
- [Participants](https://support.enrollnow.io/en/knowledge-base/participants?hsLang=en#main-content)

    - [Potential/Enrolled](https://support.enrollnow.io/en/knowledge-base/participants?hsLang=en#potential-enrolled)
    - [Sex/Gender](https://support.enrollnow.io/en/knowledge-base/participants?hsLang=en#sex-gender)
- [Tasks](https://support.enrollnow.io/en/knowledge-base/tasks?hsLang=en#main-content)

    - [Tasks](https://support.enrollnow.io/en/knowledge-base/tasks?hsLang=en#tasks)
- [Recruitment](https://support.enrollnow.io/en/knowledge-base/recruitment?hsLang=en#main-content)

    - [Sources](https://support.enrollnow.io/en/knowledge-base/recruitment?hsLang=en#sources)
    - [Strategies](https://support.enrollnow.io/en/knowledge-base/recruitment?hsLang=en#strategies)
- [Calendar](https://support.enrollnow.io/en/knowledge-base/calendar?hsLang=en)
- [Survey Creator](https://support.enrollnow.io/en/knowledge-base/survey-creator?hsLang=en#main-content)

    - [Tips and Tricks](https://support.enrollnow.io/en/knowledge-base/survey-creator?hsLang=en#tips-and-tricks)
    - [Thank you page](https://support.enrollnow.io/en/knowledge-base/survey-creator?hsLang=en#thank-you-page)
    - [Question Types](https://support.enrollnow.io/en/knowledge-base/survey-creator?hsLang=en#question-types)
- [Report Builder & Reports](https://support.enrollnow.io/en/knowledge-base/report-builder-reports?hsLang=en#main-content)

    - [Reports](https://support.enrollnow.io/en/knowledge-base/report-builder-reports?hsLang=en#reports)
    - [Report Builder Basics](https://support.enrollnow.io/en/knowledge-base/report-builder-reports?hsLang=en#report-builder-basics)
- [Study Settings](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#main-content)

    - [Requirements](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#requirements)
    - [Email and Texts](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#email-and-texts)
    - [Display](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#display)
    - [Details](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#details)
    - [Statuses](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#statuses)
    - [Bulk Tasks](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#bulk-tasks)
    - [Events](https://support.enrollnow.io/en/knowledge-base/study-settings?hsLang=en#events)
- [Import/Export](https://support.enrollnow.io/en/knowledge-base/import-export?hsLang=en#main-content)

    - [Tips and Tricks](https://support.enrollnow.io/en/knowledge-base/import-export?hsLang=en#tips-and-tricks)
    - [study definitions](https://support.enrollnow.io/en/knowledge-base/import-export?hsLang=en#study-definitions)
    - [Export](https://support.enrollnow.io/en/knowledge-base/import-export?hsLang=en#export)
- [API](https://support.enrollnow.io/en/knowledge-base/api?hsLang=en)
- [FAQs & Troubleshooting](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#main-content)

    - [Ripple Performance](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#ripple-performance)
    - [Security Settings](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#security-settings)
    - [Reuse Custom ID](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#reuse-custom-id)
    - [Internal Server Error - Importing](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#internal-server-error-importing)
    - [Account Lock out](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#account-lock-out)
    - [FAQ](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#faq)
    - [Calendar Integration Issues](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#calendar-integration-issues)
    - [e-consent downloads](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#e-consent-downloads)
    - [Support Web Pages](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#support-web-pages)
    - [EnrollNow Glossary](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#enrollnow-glossary)
    - [EnrollNow Performance](https://support.enrollnow.io/en/knowledge-base/faqs-troubleshooting?hsLang=en#enrollnow-performance)
- [Security](https://support.enrollnow.io/en/knowledge-base/security?hsLang=en#main-content)

    - [Security](https://support.enrollnow.io/en/knowledge-base/security?hsLang=en#security)
    - [Ripple Service Status Report](https://support.enrollnow.io/en/knowledge-base/security?hsLang=en#ripple-service-status-report)
- [Workflows and How To's](https://support.enrollnow.io/en/knowledge-base/workflows-and-how-tos?hsLang=en)
- [Site Admin](https://support.enrollnow.io/en/knowledge-base/site-admin?hsLang=en#main-content)

    - [Users](https://support.enrollnow.io/en/knowledge-base/site-admin?hsLang=en#users)
    - [Export](https://support.enrollnow.io/en/knowledge-base/site-admin?hsLang=en#export)
    - [Security](https://support.enrollnow.io/en/knowledge-base/site-admin?hsLang=en#security)
- [Audit Logs](https://support.enrollnow.io/en/knowledge-base/audit-logs?hsLang=en)
- [Product Release Notes](https://support.enrollnow.io/en/knowledge-base/product-release-notes?hsLang=en#main-content)

    - [2026](https://support.enrollnow.io/en/knowledge-base/product-release-notes?hsLang=en#2026)
    - [2025](https://support.enrollnow.io/en/knowledge-base/product-release-notes?hsLang=en#2025)
    - [2024](https://support.enrollnow.io/en/knowledge-base/product-release-notes?hsLang=en#2024)
    - [2023](https://support.enrollnow.io/en/knowledge-base/product-release-notes?hsLang=en#2023)
    - [2022](https://support.enrollnow.io/en/knowledge-base/product-release-notes?hsLang=en#2022)
    - [2019-2021](https://support.enrollnow.io/en/knowledge-base/product-release-notes?hsLang=en#2019-2021)

[![](https://support.enrollnow.io/hubfs/EnrollNow-Logo-Color-BlueYellow.svg)](http://enrollnow.io)

                                                                                [Privacy Policy](https://enrollnow.io/legal/privacy-policy)[Terms of Service](https://enrollnow.io/legal/terms-of-service)

Copyright © 2025, EnrollNow