OpenClinica

OpenClinica Bulk Operations API

Bulk participant and event operations plus the bulk actions log.

Documentation GitHub OpenAPI

Operations 2

POST /pages/auth/api/clinicaldata/studies/{studyOID}/participants/bulk Add or update a bulk list of participants #

GET /pages/auth/api/bulkActionsLog Retrieve the bulk actions log #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/openclinica-bulk-operations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: OpenClinica REST Bulk Operations API
  description: OpenClinica is a clinical-trial electronic data capture (EDC) and clinical data management platform.
  version: '4.0'
  contact:
    name: OpenClinica
    url: https://www.openclinica.com
  license:
    name: LGPL-2.1 (Community Edition)
    url: https://github.com/OpenClinica/OpenClinica/blob/master/LICENSE.txt
servers:
- url: https://{subdomain}.build.openclinica.io
  description: OpenClinica hosted instance (replace {subdomain} with your instance subdomain)
  variables:
    subdomain:
      default: your-instance
      description: Your OpenClinica instance subdomain.
security:
- bearerAuth: []
tags:
- name: Bulk Operations
  description: Bulk participant and event operations plus the bulk actions log.
paths:
  /pages/auth/api/clinicaldata/studies/{studyOID}/participants/bulk:
    post:
      operationId: addBulkParticipants
      tags:
      - Bulk Operations
      summary: Add or update a bulk list of participants
      description: Adds or updates a list of participants in a single request. Modeled from the OpenClinica bulk participants documentation; reconcile the exact path and payload against your instance version.
      parameters:
      - $ref: '#/components/parameters/StudyOID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                participants:
                  type: array
                  items:
                    $ref: '#/components/schemas/Participant'
      responses:
        '200':
          description: A job accepted to process the bulk participant list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobAccepted'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /pages/auth/api/bulkActionsLog:
    get:
      operationId: getBulkActionsLog
      tags:
      - Bulk Operations
      summary: Retrieve the bulk actions log
      description: Returns the log of asynchronous bulk operations (bulk participants, bulk events, extracts) and their status. Path modeled from the OpenClinica bulk actions log documentation.
      responses:
        '200':
          description: A list of bulk action log entries.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BulkActionLogEntry'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
    BulkActionLogEntry:
      type: object
      properties:
        uuid:
          type: string
        actionType:
          type: string
          example: BULK_PARTICIPANT
        status:
          type: string
          example: COMPLETED
        createdDate:
          type: string
          format: date-time
    Participant:
      type: object
      properties:
        subjectKey:
          type: string
          description: The participant (subject) identifier.
        studyOID:
          type: string
        siteOID:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phoneNumber:
          type: string
        enrollmentDate:
          type: string
          format: date
    JobAccepted:
      type: object
      properties:
        uuid:
          type: string
          description: Identifier for the asynchronous job; check status via the bulk actions log.
        status:
          type: string
          example: PENDING
  parameters:
    StudyOID:
      name: studyOID
      in: path
      required: true
      description: The unique study OID.
      schema:
        type: string
        example: S_STUDY01
  responses:
    Unauthorized:
      description: Authentication failed or the bearer token is missing, invalid, or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT