How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenClinica Participants API

Study participants (subjects) - add, update, list, and extract contact info.

OpenClinica Participants API is one of 6 APIs that OpenClinica 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 5 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 4.0.

Requests are made against a single base URL, https://{subdomain}.build.openclinica.io.

5 operations 3 paths 4 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.0
Base URL
https://{subdomain}.build.openclinica.io/user-service/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

OpenClinica Participants API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Participants 5

Study participants (subjects) - add, update, list, and extract contact info.

GET
/pages/auth/api/clinicaldata/studies/{studyOID}/participants
Get participants at study level
listStudyParticipants 1 param → 200401
POST
/pages/auth/api/clinicaldata/studies/{studyOID}/participants
Add or update a participant at study level
addStudyParticipant 1 param body → 200401
GET
/pages/auth/api/clinicaldata/studies/{studyOID}/sites/{siteOID}/participants
Get participants at site level
listSiteParticipants 2 params → 200401
POST
/pages/auth/api/clinicaldata/studies/{studyOID}/sites/{siteOID}/participants
Add or update a participant at site level
addSiteParticipant 2 params body → 200401
POST
/pages/auth/api/clinicaldata/studies/{studyOID}/sites/{siteOID}/participants/extractParticipantsInfo
Extract participant contact information
extractParticipantsInfo 2 params → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Participant (8 properties), Error (2 properties), JobAccepted (2 properties), ParticipantList (1 property). Each schema is shown below with its type and property counts.

ParticipantList
object
1 property
JobAccepted
object
2 properties
Participant
object
8 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openclinica-participants-api-openapi.yml Raw ↑

Other APIs OpenClinica publishes across the network.

OpenClinica Authentication API
OpenClinica Bulk Operations API
OpenClinica Clinical Data API
OpenClinica Metadata API
OpenClinica Study Events API
Where this information came from

This is an independent, third-party profile of OpenClinica Participants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.