Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

How to Use the Export cURL API to Export Registry or Study Data

The Export cURL API allows Site Admins and Site Managers to export data from the Registry or a specific study in Ripple without having to log into the platform or manually use the Export Tool. By running an Export cURL command, you can quickly pull data from Ripple into a CSV (Excel-compatible) file and transform it for use in third-party systems like CTMS, EDC, or CRM platforms.

This method enables faster, more regular data exports and supports data consistency across systems.

What You Need Before You Start

To build and run an Export cURL command, gather the following information:

  • Ripple Site URL (e.g., https://yourRipplesite.ripplescience.com)

  • Authorization Key (generated from your Ripple user account)

  • Study ID

    • Use "global" if exporting from the Registry

    • For a study, copy the string from the study URL in Ripple

  • Time Zone (e.g., America/New_York)

  • Variable Names (the data fields you want to export)

  • Name of the excel file to export to(e.g., StudyExport.csv)

  • Export cURL Command (formatted for your operating system)

Export cURL Command Format

For Mac Users:

curl 'RippleSiteURL/v1/export'\
--header 'Authorization: Basic AuthorizationKey'\
--data-raw 'export-type=StudyId&export-timezone=TimeZone&variableName1=on&variableName2=on&variableName3=on' > NameOfExportedExcel.csv

 

For Windows Users:

curl "RippleSiteURL/v1/export"
--header "Authorization: Basic AuthorizationKey"
--data-raw "export-type=StudyId&export-timezone=TimeZone&variableName1=on&variableName2=on&variableName3=on" > NameOfExportedExcel.csv

 

Steps to Run the Command

  1. Open your terminal

    • On Mac: Use Terminal

    • On Windows: Use Command Prompt

  2. Paste the cURL command based on your operating system from above.

  3. Update the placeholders in the command:

    • Replace RippleSiteURL with your actual Ripple Study URL

    • Replace AuthorizationKey with your key

    • Replace StudyId with the study ID in red box (or use "global" in all lowercase for Registry exports)

    • Replace TimeZone with your time zone (e.g., America/New_York)

    • Replace the variable names (e.g., firstName, statusId)

    • Replace NameOfExportedExcel.csv with your desired file name

IMPORTANT NOTES: 

  • Variable names are case-sensitive and must match how they appear on the Data Dictionary or Export Page.

  • Spaces are typically replaced by underscores.

  • Custom variables must begin with cv. — e.g., cv.potential_eligibility.


Special Formatting for Built-In Ripple Variables

Ripple Variable Format for Export cURL Command
Events (All or None) Events+%28+All+or+None+%29
Participant Contacts Participant+Contacts
Comments Log Comments+Log
Contact Log Contact+Log
Email Log Email+Log
Consent Log Consent+Log
 

NOTE:  Exporting survey data requires additional formatting.

 

Example Export cURL Command

Let’s say a data analyst asks you to export the following fields from your Ancillary A Study: first name, last name, global ID, custom ID, status, sex, and race.

Here’s what your command would look like in a Mac:

curl 'https://supportplayground.ripplescience.org/v1/export' \
--header 'Authorization: Basic ZXhhbXBsZS51c2VyQHJpcHBsZXNjaWVuY2UuY29tOnN1cGVyc2VjcmV0cGFzc3dvcmQxMjMK' \
--data-raw 'export-type=bdHZw2JPpZxvcY6Qv&export-timezone=America%2FChicago&firstName=on&lastName=on&globalId=on&customId=on&statusId=on&sex=on&race=on' > StudyDataExport.csv

 

NOTE:  Be sure to choose the correct cURL command based on your device (Mac or Windows). Double-check that your Site URL, Authorization Key, and Study ID match your Ripple site and user permissions to ensure the export is successful.

Need Help?

If you're unsure about your Study ID, authorization key, or variable names, or if your export isn't working as expected, please contact the Ripple Support Team.