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 Participants API

Participants (records / subjects) enrolled in a study.

Castor Participants API is one of 11 APIs that Castor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Participants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 3 schemas. 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.

3 operations 2 paths 3 schemas 2 GET1 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 Participants 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 3

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

Participants 3

Participants (records / subjects) enrolled in a study.

GET
/study/{study_id}/participant
List participants
listParticipants 2 params → 200401
POST
/study/{study_id}/participant
Create a participant
createParticipant 1 param body → 201401
GET
/study/{study_id}/participant/{participant_id}
Retrieve a participant
getParticipant 2 params → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ParticipantCollection (3 properties), ParticipantInput (3 properties). Each schema is shown below with its type and property counts.

ParticipantInput
object
3 properties
Participant
ParticipantCollection
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

castoredc-participants-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 Reports API
Castor Studies API
Castor Study Data Points API
Castor Surveys API
Castor Users API