Application Programming Interface (API)

• Can I use an Application Programming Interface (API) to access Castor?

  Castor has a public API that can be used to push and pull data from Castor. All API documentation can be found at data.castoredc.com/api.  Please make sure you use the right URL, depending on where yo...

• Is it possible to upload files with the API?

  It is possible to upload files into an “Upload file” field, e.g. with the endpoint /study/{study_id}/record/{record_id}/study-data-point/{field_id} The file needs to be in the parameter upload_file, w...

• Can I retrieve uploaded files through the API?

  At the moment it is not possible to download uploaded files via API. There is an option to download all uploaded files via the regular export:...

• Where can I find IDs for the study/field/report instance/... for the API?

  All IDs that you need to use for the API (except for the record ID) are uppercase GUIDs, which generally look like 93852ECC-18F1-4829-A453-87B924B08D84 so 8-4-4-4-12 characters. The study ID can be fo...

• Can I add/edit a record’s email address through the API?

  It is possible to create a new record with an email address through the API with: /study/{study_id}/record It is not possible to edit the email address for an existing record with the API....

• Can I import/post or export/get encrypted data through the API?

  Sending (POST) data It is possible to send (POST) data for encrypted fields, e.g. with  /study/{study_id}/record/{record_id}/study-data-point/{field_id} Retrieving (GET) data It is not possible to ret...

• How are grid field values and checkbox values retrieved from the API?

  Grids Grid field values are stored as so-called JSON objects. A JSON object looks like this: {0:{0:A,1:C},1:{0:B,1:D}} In this case, the grid field consists of 2 rows, numbered 0 and 1 (outside the in...

• Where can I find my user/client credentials to use the API/R package?

  You can find the client ID and secret in your Account Settings in Castor. You can access your Account Settings from the blue bar, hover over 'Account', then click on 'Settings'. Find your user credent...

• Parameters used in the API

  The Castor EDC API Documentation page (https://data.castoredc.com/api, https://uk.castoredc.com/api, https://us.castoredc.com/api) gathers the methods and requirements of the fields in Castor to be us...

• Which data can be retrieved (GET) and sent (POST) with the API?

  The table below shows an overview of the fields for which data can be sent (POST) and retrieved (GET) with API endpoints. See also the introduction to the API and the API documentation. Action Field P...