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

Study fields and their metadata (dependencies, option groups, validations).

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

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

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

5 operations 5 paths 2 schemas 5 GET

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 Fields 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 5

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

Fields 5

Study fields and their metadata (dependencies, option groups, validations).

GET
/study/{study_id}/field
List fields
listFields 2 params → 200401
GET
/study/{study_id}/field/{field_id}
Retrieve a field
getField 2 params → 200404
GET
/study/{study_id}/field-dependency
List field dependencies
listFieldDependencies 1 param → 200
GET
/study/{study_id}/field-optiongroup
List field option groups
listFieldOptionGroups 1 param → 200
GET
/study/{study_id}/field-validation
List field validations
listFieldValidations 1 param → 200

Schemas 2

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

Field
object
7 properties
FieldCollection
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

castoredc-fields-api-openapi.yml Raw ↑

Other APIs Castor publishes across the network.

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