Skip to content

Setting the User Rights to Grant API Access

Shawn Garbett edited this page Jan 25, 2023 · 1 revision

Each user who wishes to access data through the API must be given specific permissions to do so. These permissions are provided on a project basis. That is, a token is specific to a single project. To grant a user API access, follow these steps:

  1. Navigate to your REDCap home page and log in.

  2. Click on the tab for "My Projects" and select a project for which you wish to grant access to the API

  3. Select a "User Rights" option from the left navigation pane.

  4. Click on a user name to make the User Actions balloon appear. Select "Edit User Privileges"

  5. Click on the appropriate options for the user's access to the project data and API import/export access

Remember that in REDCap versions earlier than 6.0, API exports default to 'Full Data Export.' As strange as it seems, a user with "No Access" in the Data Export Tool may still download the complete and identifiable data through the API if API access is given. Only in Version 6.0 and later does the API mirror data export rights.