Skip to main content
POST
/
v1
/
bulk
/
export
Start bulk export
curl --request POST \
  --url https://api.clinikapi.com/v1/bulk/export \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "resourceTypes": [
    "<string>"
  ],
  "since": "2023-11-07T05:31:56Z"
}
'
{
  "data": {
    "jobId": "<string>",
    "status": "<string>",
    "message": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
resourceTypes
string[]
required

FHIR resource types to export (e.g. Patient, Encounter, Observation)

since
string<date-time>

Only export resources modified after this date

Response

202 - application/json

Export job started

data
object