Skip to main content
POST
/
v1
/
patients
Create patient
curl --request POST \
  --url https://api.clinikapi.com/v1/patients \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "birthDate": "<string>",
  "address": {
    "line": [
      "<string>"
    ],
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "maritalStatus": "<string>",
  "photo": {
    "url": "<string>",
    "data": "<string>",
    "contentType": "<string>"
  },
  "contact": [
    {
      "relationship": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phone": "<string>",
      "email": "[email protected]",
      "address": {
        "line": [
          "<string>"
        ],
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      }
    }
  ],
  "languages": [
    {
      "language": "<string>",
      "preferred": true
    }
  ],
  "generalPractitionerId": "<string>"
}
'
{
  "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_*)

Body

application/json
firstName
string
required
Maximum string length: 100
lastName
string
required
Maximum string length: 100
email
string<email>
phone
string
Maximum string length: 20
gender
enum<string>
Available options:
male,
female,
other,
unknown
birthDate
string

Date of birth (YYYY-MM-DD)

address
object
maritalStatus
string

Marital status (married, single, divorced, widowed)

Maximum string length: 50
photo
object
contact
object[]

Emergency contacts / next of kin

Maximum array length: 10
languages
object[]

Languages the patient speaks

Maximum array length: 20
generalPractitionerId
string

Reference to the patient's GP (Practitioner ID)

Response

Patient created

data
any

The resource or result payload

meta
object