16.9 Participants (Get Participants at Study Level or Site Level)

Use these endpoints to retrieve a list of Participants at the study level or site level in OpenClinica.

You must be authenticated before calling these endpoints. Access is determined by your assigned user role and privileges.

Study-Level: Get All Participants in a Study

Use this endpoint to retrieve all Participants across a study.

Roles and Permissions

User roles authorized to call this endpoint:

• Data Manager
• Investigators

User roles NOT authorized to call this endpoint:

• Clinical Research Coordinators (CRC)
• Monitors (study level and site level)

Endpoint

GET

{serverName}/pages/auth/api/clinicaldata/studies/{studyOID}/participants

Where:

• {serverName} is your study URL.

Example:

https: //studyxyz.eu.openclinica.io/OpenClinica

Site-Level: Get Participants for a Specific Site

Use this endpoint to retrieve Participants associated with a specific site within a study.

Roles and Permissions

User roles authorized to call this endpoint:

• Data Manager
• Investigators
• Clinical Research Coordinators (CRC)

ℹ️ Note:
If you have a site-level role, you can retrieve Participants only for your assigned site.

User roles NOT authorized to call this endpoint:

• Monitors (study level and site level)

Endpoint

GET

{serverName}/pages/auth/api/clinicaldata/studies/{studyOID}/sites/{siteOID}/participants

Where:

{serverName} is your study URL.

Example:

https: //studyxyz.eu.openclinica.io/OpenClinica

curl -X GET \
  '{(serverName/pages/auth/api/clinicaldata/studies/[studyID}/sites/(siteI})/participants' \
  -H 'Authorization: bearer (authentication token))'

{
  "studyParticipants": [
    {
      "subjectKey": "LA-1",
      "subjectOid": "SS_LA1",
      "status":
      "Available",
      "createdBy": "testuser",
      "createdAt": "Apr 26, 2019 12:00:00 AM",
      "lastModified": "Apr 26, 2019 12:00:00 AM",
      "lastModifiedBy": "testuser"
    },
    {
      "subjectKey": "LA-2",
      "subjectOid": "SS_LA2",
      "status": "Available",
      "createdBy":
      "testuser",
      "createdAt": "Apr 26, 2019 12:00:00 AM",
      "lastModified":
      "Apr 26, 2019 12:00:00 AM",
      "lastModifiedBy": "testuser"
    }
  ]
}