Where can I learn more about REDCap’s API

Most REDCap users will use the normal web-based user interface to interact with their REDCap projects. However, REDCap also has the capability to support programmatic access through an API protocol (Application Programming Interface).

Once enabled, any other program with Internet access can then use the API protocol to interact with REDCap projects. API access is limited by an API token that is unique for every user/project combination and is constrained by the applicable user rights for that user in that project.

Documentation on how to use the API feature can be somewhat difficult to find. The standard API documentation can be found in any REDCap installation. For the ITHS installation, the API documentation can be found by accessing the ITHS REDCap instance, which requires an active account.

A basic introduction on how to use the REDCap API can be found by visiting a page maintained on sburns.org. Alternatively, ITHS’ Chris Nefcy has created a web page that allows people to “try out” various API calls in combination with their project without actually needing to program it themselves. This is a great way to discover what each API call type does and how you can best implement it for your specific project.

Back to FAQs 0 0

Cite ITHSThe Institute is supported by grants UL1 TR002319, KL2 TR002317, and TL1 TR002318 from the NIH National Center for Advancing Translational Sciences through the Clinical and Translational Science Awards Program (CTSA).

Please help us continue to support your research by citing our grant number(s) in publications we supported.