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:

General API Info

Supported Methods

Arms
Data Access Groups
Events
Field Names
Files
File Repository
Instruments
Logging
Metadata
Projects
Records
Repeating Instruments and Events
Reports
REDCap
Surveys
Users & User Privileges
User Roles
REDCap API Documentation

In order to use the REDCap API for a given REDCap project, you must first be given a token that is specific to your username for that particular project. Rather than using username/passwords, the REDCap API uses tokens as a means of secure authentication, in which a token must be included in every API request. Please note that each user will have a different token for each REDCap project to which they have access. Thus, multiple tokens will be required for making API requests to multiple projects.

To obtain an API token for a project, navigate to that project, then click the API link in the Applications sidebar. On that page you will be able to request an API token for the project from your REDCap administrator, and that page will also display your API token if one has already been assigned. If you do not see a link for the API page on your project's left-hand menu, then someone must first give you API privileges within the project (via the project's User Rights page).

Super Tokens: If you wish to utilize the 'Create Project' API method, then a Super API Token is required. Super tokens are 64-characters in length (as opposed to 32-character-long regular tokens), in which a REDCap user can only have one super token at most. If you are interested in obtaining a super token, please contact your local REDCap administrator.

REDCap Software - Version 14.9.1 - © 2024 Vanderbilt University