The participant-device-token API from Castor — 1 operation(s) for participant-device-token.
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-participant-device-token-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 Participant Device Token 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: participant-device-token
paths:
/study/{study_id}/participant/{participant_id}/device-token:
get:
tags:
- participant-device-token
summary: Retrieve the participant device token 🔭
security:
- OAuth2ClientCredentials:
- record
description: Retrieve the participant device token. Supports the `record` scope.
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
- name: participant_id
in: path
description: The ID of the participant for which this call should be made
required: true
schema:
type: string
responses:
200:
description: Participant device token retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/ParticipantDeviceToken'
403:
description: Not allowed to view data for this participant.
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: getStudyByStudyIdParticipantByParticipantIdDeviceToken
x-operation-id-source: derived
post:
tags:
- participant-device-token
summary: Register a device token for a participant 🔭
security:
- OAuth2ClientCredentials:
- record
description: Create a device token for a participant. Supports the `record` scope.
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
- name: participant_id
in: path
description: The ID of the participant for which this call should be made
required: true
schema:
type: string
responses:
201:
description: Participant device token created successfully
400:
description: Invalid input
403:
description: Not allowed to view data for this participant.
404:
description: The given Participant does not exist.
422:
description: Unprocessable entity - see error details for more information.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceToken'
description: The participants device token and app version to register
required: true
operationId: postStudyByStudyIdParticipantByParticipantIdDeviceToken
x-operation-id-source: derived
patch:
tags:
- participant-device-token
summary: Updates an existing participant device token 🔭
security:
- OAuth2ClientCredentials:
- record
description: Supports the `record` scope.
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
- name: participant_id
in: path
description: The ID of the participant for which this call should be made
required: true
schema:
type: string
responses:
200:
description: Participant device token updated.
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceToken'
403:
description: Not allowed to view data for this participant.
404:
description: Participant device token not found.
422:
description: Unprocessable entity - see error details for more information.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceToken'
description: The participants device token and app version to update
required: true
operationId: patchStudyByStudyIdParticipantByParticipantIdDeviceToken
x-operation-id-source: derived
delete:
tags:
- participant-device-token
summary: Delete the participants device token 🔭
security:
- OAuth2ClientCredentials:
- record
description: Removes the participants device token effectively unlinking their device. Supports the `record` scope.
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
- name: participant_id
in: path
description: The ID of the participant for which this call should be made
required: true
schema:
type: string
responses:
204:
description: Token successfully deleted
403:
description: Not allowed to edit data for this participant.
404:
description: Participant device token not found
422:
description: Unprocessable entity - see error details for more information.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: deleteStudyByStudyIdParticipantByParticipantIdDeviceToken
x-operation-id-source: derived
components:
schemas:
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
DateTime:
type: object
description: A serialized PHP DateTime object.
properties:
date:
type: string
description: Date and time in Y-m-d H:i:s.u format.
timezone_type:
type: integer
timezone:
type: string
DeviceToken:
type: object
properties:
device_token:
type: string
app_version:
type: string
ParticipantDeviceToken:
description: Links the participant to a personal device, allowing for direct push notifications
type: object
properties:
device_token:
type: string
description: The token linking a device such as a smartphone to the participant
app_version:
type: string
description: Castor Connect App version
participant_id:
type: string
created_on:
$ref: '#/components/schemas/DateTime'
updated_on:
$ref: '#/components/schemas/DateTime'
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)