Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Castor Surveys API

Surveys, survey packages, and ePRO.

Castor Surveys API is one of 11 APIs that Castor publishes on the 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.

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://data.castoredc.com/api, https://us.castoredc.com/api.

4 operations 4 paths 0 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://data.castoredc.com/api
Authentication
OAuth 2.0
Contact
Resource Areas
1

Authentication & Security 1

Castor Surveys API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Surveys 4

Surveys, survey packages, and ePRO.

GET
/study/{study_id}/survey
List surveys
listSurveys 1 param → 200
GET
/study/{study_id}/participant/{participant_id}/data-points/survey-instance
List a participant's survey instances
listSurveyInstances 2 params → 200
POST
/study/{study_id}/participant/{participant_id}/data-points/survey-package-instance
Send a survey package to a participant
createSurveyPackageInstance 2 params body → 201
POST
/study/{study_id}/compliance
Retrieve participant survey compliance
getSurveyCompliance 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

castoredc-surveys-api-openapi.yml Raw ↑

Other APIs Castor publishes across the network.

Castor Audit Trail API
Castor Data Export API
Castor Fields API
Castor Institutes API
Castor Metadata API
Castor Participants API
Castor Reports API
Castor Studies API
Castor Study Data Points API
Castor Users API