Working …
This value you provided is not a number. Please try again.
This value you provided is not an integer. Please try again.
The value entered is not a valid Vanderbilt Medical Record Number (i.e. 4- to 9-digit number, excluding leading zeros). Please try again.
The value you provided must be within the suggested range
The value you provided is outside the suggested range
This value is admissible, but you may wish to double check it.
The value entered must be a time value in the following format HH:MM within the range 00:00-23:59 (e.g., 04:32 or 23:19).
This field must be a 5 or 9 digit U.S. ZIP Code (like 94043). Please re-enter it now.
This field must be a 10 digit U.S. phone number (like 415 555 1212). Please re-enter it now.
This field must be a valid email address (like joe@user.com). Please re-enter it now.
The value you provided could not be validated because it does not follow the expected format. Please try again.
Required format:

Notifications

System Notifications
General Notifications

Conversations

Create new conversation

Pregnancy tracking ToolPID 31
API Playground

The API Playground is an interface that allows experimentation with the REDCap API without actually writing any code. You can explore all the different API methods and their various options to customize a given API request. You may even execute a real API request and see the exact response that REDCap returns from the request. If you are interested in creating an API script, the section at the bottom will provide code samples for various programming languages to give you a head start. For details on the capabilities of the REDCap API and how to use it, please see the REDCap API documentation.

Select an API method from the drop-down list below, after which it will load any other options that are specific to that method.
API Method:
Format:
Errors:
Displayed in the box below are all the POST parameters that would be sent in the API request based on the selections above.
Click the Execute Request button to execute a real API request, and it will display the API response in a text box below.


 
Displayed in the box below is the code you would use to execute this API request in the selected programming language.


Download PHP code examples


REDCap 15.1.0 - © 2025 Vanderbilt University - Cookie policy