Skip to main content
GET
/
v1
/
patients
Search patients
curl --request GET \
  --url https://api.clinikapi.com/v1/patients \
  --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_*)

Query Parameters

name
string

Search by name (partial match)

email
string
phone
string
gender
string
birthDate
string
active
boolean
count
integer
default:20

Results per page

Required range: x <= 100
cursor
string

Pagination cursor from previous response

Response

200 - application/json

Paginated patient list

data
any

The resource or result payload

meta
object