The role API from Castor — 2 operation(s) for role.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/castoredc:castoredc-role-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2026.1.6.1
title: Castor EDC API Documentation Role API
description: '### Overview
This document provides the specifications of the Castor EDC API, describing the currently available
API endpoints and methods. We aim to provide a fully functional RESTful API to communicate with
Castor EDC and these are endpoints currently available.
The formal OpenAPI 2 specification by which this page is rendered is also available in the following formats:
* YAML
* JSON
* JSON (pretty print)
### Authentication & Authorization with OAuth 2
Authentication and authorization are arranged through OAuth2. We currently provide full support for the Client
Credentials flow. The Authorization Code flow is supported, but we ask you to contact us if you want to use this flow.
To use the Client Credentials flow go to your
Castor EDC profile and generate
a Client ID and Client Secret. Use the Client ID and Client Secret to retrieve an access token by making a request to
the ''/oauth/token'' endpoint with your client_id and client_secret as parameters and grant_type=client_credentials.
PHP Example:
```php
include __DIR__.''/vendor/autoload.php'';
use Guzzle\Http\Client;
// Create the HTTP Client.
$httpClient = new Client(
''https://data.castoredc.com'',
[
''request.options'' => [
''exceptions'' => false,
]
]
);
// Build the request
$request = $httpClient->post(
''/oauth/token'',
null,
[
''client_id'' => ''YourCastorClientId'',
''client_secret'' => ''YourCastorClientSecret'',
''grant_type'' => ''client_credentials'',
]
);
// Send the request
$response = $request->send();
$responseBody = $response->getBody(true);
$responseArr = json_decode($responseBody, true);
$accessToken = $responseArr[''access_token''];
```
In your subsequent requests you can use the `$accessToken` as a Bearer token in the Authorization header, i.e:
```php
$request = $httpClient->get(''/api/user'');
$request->addHeader(''Authorization'', ''Bearer ''. $accessToken);
$response = $request->send();
echo $response->getBody();
```
### OAuth2 Scopes
There are 3 scopes that endpoints may support.
* **default**: allows access to all endpoints
* **study_statistics**: allows access to study statistics
* **record**: allows access to data for a single participant
Due to a bug in the OpenAPI UI, all three scopes are listed for all endpoints.
If the endpoint supports something other than the default scope, the summary will have a 🔭 emoji and the scope will be
listed in the description as well as under the `security:` key in the specification.
### Rate Limits
Unless specified in the resource, endpoints are rate-limited to 600 requests in 10 minutes.
### Legacy (Basic HTTP Authentication)
**Please note: Basic HTTP Authentication has been removed on 2019 August 13**
### Changelog
API changes can be viewed here'
contact:
name: support@castoredc.com
servers:
- url: https://data.castoredc.com/api/
security:
- OAuth2ClientCredentials:
- default
- study_statistics
- record
tags:
- name: Role
paths:
/study/{study_id}/role:
get:
summary: A list of roles related to the Study
tags:
- Role
responses:
200:
description: OK
content:
application/hal+json:
schema:
title: Roles HalJSON representation
type: object
properties:
_links:
$ref: '#/components/schemas/LinksCollection'
_embedded:
type: object
properties:
roles:
type: array
items:
$ref: '#/components/schemas/Role'
total_items:
description: Number of items returned.
type: number
default:
description: Unexpected error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
403:
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
parameters:
- name: study_id
in: path
description: The ID of the study for which this call should be made
required: true
schema:
type: string
format: UUID
operationId: getStudyByStudyIdRole
x-operation-id-source: derived
post:
tags:
- Role
summary: Creates a role
description: Creates `Role` object.
parameters:
- name: study_id
in: path
description: The ID of the study for which this call should be made
required: true
schema:
type: string
format: UUID
responses:
201:
description: Role successfully created
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Role'
403:
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
400:
description: Invalid request parameters.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
422:
description: Unprocessable entity - role already exists
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Unexpected error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/newRole'
description: Role to add
required: true
operationId: postStudyByStudyIdRole
x-operation-id-source: derived
/study/{study_id}/role/{role_name}:
get:
tags:
- Role
summary: Retrieve a single Role
description: Returns HalJson objects (with _links).
parameters:
- name: study_id
in: path
description: The ID of the study for which this call should be made
required: true
schema:
type: string
format: UUID
- description: Role name
name: role_name
in: path
required: true
schema:
type: string
responses:
200:
description: Single Role
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Role'
default:
description: Unexpected error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
403:
description: Forbidden
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
404:
description: The given Record or Field does not exist.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Error'
operationId: getStudyByStudyIdRoleByRoleName
x-operation-id-source: derived
components:
schemas:
Role:
type: object
properties:
name:
description: Role name
type: string
description:
description: Role description
type: string
permissions:
type: object
properties:
add:
description: add permission
type: boolean
view:
description: view permission
type: boolean
edit:
description: edit permission
type: boolean
delete:
description: delete permission
type: boolean
lock:
description: lock permission
type: boolean
query:
description: query permission
type: boolean
export:
description: export permission
type: boolean
randomization_read:
description: randomization_read permission
type: boolean
sign:
description: sign permission
type: boolean
email_addresses:
description: email_addresses permission
type: boolean
randomization_write:
description: randomization_write permission
type: boolean
sdv:
description: sdv permission
type: boolean
survey_send:
description: survey_send permission
type: boolean
survey_view:
description: survey_view permission
type: boolean
televisit:
description: televisit permission
type: boolean
encrypt:
description: encrypt permission
type: boolean
decrypt:
description: decrypt permission
type: boolean
validation:
description: validation permission
type: boolean
catalyst_upload:
description: catalyst_upload permission
type: boolean
_links:
$ref: '#/components/schemas/LinksSingle'
LinksCollection:
type: object
properties:
self:
type: object
properties:
href:
type: string
first:
type: object
properties:
href:
type: string
last:
type: object
properties:
href:
type: string
next:
type: object
properties:
href:
type: string
LinksSingle:
type: object
properties:
self:
type: object
properties:
href:
type: string
Error:
type: object
properties:
status:
type: integer
format: int32
description: The HTTP return code.
title:
type: string
description: The short error description belonging to the status code
detail:
type: string
description: The detailed explanation of the failure
type:
type: string
description: URL to RFC explaining this statuscode
errors:
type: object
description: Optional list of all errors that occurred during the request
validation_messages:
type: object
description: Optional list of validation failure message
newRole:
type: object
required:
- name
properties:
name:
description: Role name
type: string
description:
description: Role description
type: string
permissions:
type: object
properties:
add:
description: add permission
type: boolean
view:
description: view permission
type: boolean
edit:
description: edit permission
type: boolean
delete:
description: delete permission
type: boolean
lock:
description: lock permission
type: boolean
query:
description: query permission
type: boolean
export:
description: export permission
type: boolean
randomization_read:
description: randomization_read permission
type: boolean
sign:
description: sign permission
type: boolean
email_addresses:
description: email_addresses permission
type: boolean
randomization_write:
description: randomization_write permission
type: boolean
sdv:
description: sdv permission
type: boolean
survey_send:
description: survey_send permission
type: boolean
survey_view:
description: survey_view permission
type: boolean
televisit:
description: televisit permission
type: boolean
encrypt:
description: encrypt permission
type: boolean
decrypt:
description: decrypt permission
type: boolean
validation:
description: validation permission
type: boolean
catalyst_upload:
description: catalyst_upload permission
type: boolean
securitySchemes:
OAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
scopes:
default: Grants access to everything
study_statistics: Grants access to a study's statistics
record: Grants access to the data for a single participant; intended for use by study subjects
tokenUrl: https://data.castoredc.com/oauth/token
x-provenance:
method: harvested
publisher: Castor
source: https://data.castoredc.com/api/swagger
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)