# Castor Survey API

**Canonical:** https://apis.io/apis/castoredc/castoredc-survey-api/  
**Provider:** Castor — https://apis.io/providers/castoredc/  
**Base URL:** https://data.castoredc.com/api  
**Documentation:** https://helpdesk.castoredc.com/hc/en-us/articles/27149233860509-Castor-EDC-CDMS-Application-Programming-Interface-API

Castor Survey API is one of 45 APIs that [Castor](https://apis.io/providers/castoredc/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Surveys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The survey API from Castor — 14 operation(s) for survey.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| POST | `/study/{study_id}/compliance` | Retrieve participant survey compliance information |
| GET | `/study/{study_id}/surveypackage` | Retrieve list of available Survey Packages |
| GET | `/study/{study_id}/surveypackage/{survey_package_id}` | Retrieve a single Survey Package |
| GET | `/study/{study_id}/surveypackageinstance` | Retrieve list of available SurveyPackageInstances |
| POST | `/study/{study_id}/surveypackageinstance` | Creates a SurveyPackageInstance and (optionally) send the email invite directly |
| GET | `/study/{study_id}/surveypackageinstance/{survey_package_instance_id}` | Retrieve a single Survey Package Instance |
| PATCH | `/study/{study_id}/surveypackageinstance/{survey_package_instance_id}` | Locks/unlocks a SurveyPackageInstance |
| PATCH | `/study/{study_id}/record/{record_id}/surveypackageinstance/{survey_package_instance_id}` | Updates the start time or the delivery time for a SurveyPackageInstance 🔭 |
| GET | `/study/{study_id}/survey` | Retrieve list of available Surveys |
| GET | `/study/{study_id}/survey/{survey_id}` | Retrieve a single Survey |
| GET | `/study/{study_id}/survey-package` | Retrieve list of available Survey Packages |
| GET | `/study/{study_id}/survey-package/{survey_package_id}` | Retrieve a single Survey Package |
| GET | `/study/{study_id}/survey-package-instance` | Retrieve list of available SurveyPackageInstances |
| POST | `/study/{study_id}/survey-package-instance` | Creates a SurveyPackageInstance and (optionally) send the email invite directly |
| GET | `/study/{study_id}/survey-package-instance/{survey_package_instance_id}` | Retrieve a single Survey Package Instance |
| PATCH | `/study/{study_id}/survey-package-instance/{survey_package_instance_id}` | Updates a SurveyPackageInstance. Can be used to lock/unlock or mark as sent |
| PATCH | `/study/{study_id}/participant/{participant_id}/survey-package-instance/{survey_package_instance_id}` | Updates the start time or the delivery time for a SurveyPackageInstance 🔭 |
| PATCH | `/study/{study_id}/participant/{participant_id}/survey-package-instance` | Updates the start time or the received time of multiple Survey Package… |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/castoredc/refs/heads/main/openapi/castoredc-survey-api-openapi.yml
- **Documentation** — https://helpdesk.castoredc.com/hc/en-us/articles/27149233860509-Castor-EDC-CDMS-Application-Programming-Interface-API
- **APIReference** — https://data.castoredc.com/api
- **PostmanCollection** — https://raw.githubusercontent.com/api-evangelist/castoredc/refs/heads/main/collections/castoredc.postman_collection.json
- **OpenCollection** — https://raw.githubusercontent.com/api-evangelist/castoredc/refs/heads/main/collections/castoredc.opencollection.json

## Other Castor APIs (12)

- [Castor Metadata API](https://apis.io/apis/castoredc/castoredc-metadata-api/)
- [Castor Beta API](https://apis.io/apis/castoredc/castoredc-beta-api/)
- [Castor Castor Internal API](https://apis.io/apis/castoredc/castoredc-castor-internal-api/)
- [Castor Country API](https://apis.io/apis/castoredc/castoredc-country-api/)
- [Castor Data Point Collection API](https://apis.io/apis/castoredc/castoredc-data-point-collection-api/)
- [Castor Data Points API](https://apis.io/apis/castoredc/castoredc-data-points-api/)
- [Castor Export API](https://apis.io/apis/castoredc/castoredc-export-api/)
- [Castor Field API](https://apis.io/apis/castoredc/castoredc-field-api/)
- [Castor Field Dependency API](https://apis.io/apis/castoredc/castoredc-field-dependency-api/)
- [Castor Field Optiongroup API](https://apis.io/apis/castoredc/castoredc-field-optiongroup-api/)
- [Castor Field Validation API](https://apis.io/apis/castoredc/castoredc-field-validation-api/)
- [Castor Form API](https://apis.io/apis/castoredc/castoredc-form-api/)

## Tags

Surveys

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/castoredc/castoredc-survey-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/castoredc/.