Start a conversation

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 found in the study settings in Castor EDC or with the endpoint
/study
  • Record IDs are the same as they are listed in the Records tab in your study.
  • All other IDs (e.g. field, report (instance), survey (package instance)) can be found with the endpoints as listed in the API documentation. For example, you can find a field ID with the endpoint 
/study/{study_id}/field
Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Castor Support Team

  2. Posted
  3. Updated