Skip to content

Step 3: Get API Access

This guide explains how to request and configure API access for your REDCap project.

Prerequisites

  • [x] Active REDCap account (Step 1)
  • [x] Created REDCap project (Step 2)

What is an API Token?

An API token is a unique key that allows programmatic access to your REDCap project. With it, you can:

  • Upload instrument definitions
  • Import/export data
  • Manage project settings

Security Notice

Your API token grants full access to your project. Never share it publicly or commit it to version control.

Request API Access

1. Navigate to API Settings

  1. Log in to REDCap at https://redcapdev.uol.de
  2. Open your project
  3. Go to Applications → API (in the left sidebar)

Missing the API option in the sidebar?

If you don’t see Applications → API (or the Request API token button), your REDCap user account likely does not have permission to request an API token for this project. Contact your REDCap administrator to enable API rights.

2. Request API Token

Click the "Request API token" button.

3. Wait for Approval

  • The administrator will review your request
  • Approval typically takes 1-2 business days
  • You'll receive an email notification when approved

5. Copy Your API Token

Once approved:

  1. Return to Applications → API
  2. Your token will be displayed
  3. Click "Copy" to copy the token

Important

Copy and store your token securely. You may not be able to view it again.

About Storing Your API Key

You will need to store your API key locally to use it with rcol. Detailed instructions for saving it as a .env file are provided in Step 5: Upload Instruments. For now, just make sure you know how to access your token from Applications → API in REDCap.

API Permissions

Your API token may have different permission levels:

Permission Description
Import/Update Upload data and metadata
Export Download data and metadata
Delete Remove records
Design Modify project structure

Minimum Required

For rcol, you need at least Import/Update permission to upload instruments.

What's Next?

Once you have API access, proceed to:

→ Step 4: Setup Python

Troubleshooting

My API request was denied
  • Provide more detailed justification
  • Have your supervisor approve the request
  • Contact the REDCap administrator
I lost my API token
  • Request a new token from the API page
  • The old token will be revoked
API calls return 403 Forbidden
  • Verify your token is correct
  • Check your user rights in REDCap
  • Ensure the project is not in Production mode (or you have production rights)