Participant contact information is comprised of the participant’s contact information captured for the study and the participant access code generated for accessing OpenClinica Participate.

The below given endpoint(s) are used to extract all that information for use cases such as physically mailing a letter to all participants, and/or integrating with a CTMS system, which requires participant contact information. 

Only Site-level CRCs and Investigators can call this endpoint to extract information about participants in the site to which they have been given access. If they have been given access to more than one site, they must make multiple calls – only one site can be specified per call. For example, User A with access to Site A and Site B, when s/he submits a request for Site A participants then ONLY site A participants information will be returned in the file. Participants who have been removed are not included in the results.

Extracting contact information is a two step process:

  1. Authorized user submits the request for extracting participant information
  2. Once the job completes, the same user calls the download file endpoint to get the file containing extracted participant information

Below are the details about the two endpoints:

Submit the request:

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

where {serverName} is your study URL. For example: https: //

Sample cURL request:

curl -X GET 
  -H 'Authorization: bearer {{authentication token}}'

Response Body on Success:

Endpoint will submit the job in the background and will return the unique job uuid. This job uuid can be used to download the file which contains the extracted participant information.

job uuid: hi12345j-2b02-482f-3h7s-286d54555f25

Response Body on Operation Failure:

  "message": "errorCode.studyNotExist",
  "params": {
    "siteOid": "sdgsg",
    "studyOid": "sdgsd"

Below is the list of all errorCodes with their descriptions:

  • errorCode.studyNotExist: The Study OID specified in the request is not found.
  • errorCode.siteNotExist: The Site OID specified in the request is not found.
  • errorCode.noRoleSetUp: The user has no role assigned for the given Study/Site.
  • errorCode.noSufficientPrivileges: The user does not have sufficient privileges to perform this operation.

Download the file:

GET {serverName}/pages/auth/api/jobs/{jobUuid}/downloadFile

where {serverName} is your study URL. For example: https: //

Sample cURL request:

curl -X GET 
  -H 'Authorization: bearer {{authentication token}}'

Below is the list of all the errorCodes with their descriptions:

  • errorCode.invalidUuid: The Job Uuid specified in the request is not found.