Read Patient - ClinikAPI

Read patient

curl --request GET \
  --url https://api.clinikapi.com/v1/patients/{id} \
  --header 'x-api-key: <api-key>'

{
  "data": "<unknown>",
  "meta": {
    "requestId": "req_k8f3a7x2",
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 200,
    "rateLimitTotal": 123,
    "rateLimitRemaining": 123,
    "rateLimitReset": 123
  }
}

GET

patients

{id}

Read patient

curl --request GET \
  --url https://api.clinikapi.com/v1/patients/{id} \
  --header 'x-api-key: <api-key>'

{
  "data": "<unknown>",
  "meta": {
    "requestId": "req_k8f3a7x2",
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 200,
    "rateLimitTotal": 123,
    "rateLimitRemaining": 123,
    "rateLimitReset": 123
  }
}

Authorizations

x-api-key

string

header

required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Path Parameters

string

required

Resource ID

Query Parameters

_revinclude

string[]

Include related resources (e.g. Encounter:subject, Observation:subject)

Response

200 - application/json

Patient with optional included resources

data

any

The resource or result payload