Get a patient

Retrieve a single patient by ID.

Authorization

AuthorizationRequiredBearer <token>

Use your API key (sk_live_* or sk_test_*) as the Bearer token.

In: header

Path Parameters

idRequiredstring

curl -X GET "https://platform.caramedical.com/api/v1/patients/<string>" \
  -H "Authorization: Bearer <token>"

Patient details.

{
  "id": "pat_1706000000_abc123def",
  "externalId": "string",
  "joiningCode": "PULSE-A1B2C3D4",
  "email": "user@example.com",
  "phone": "+15551234567",
  "firstName": "string",
  "lastName": "string",
  "dateOfBirth": "2019-08-24",
  "gender": "string",
  "address": "string",
  "patientType": "prospect",
  "patientStatus": "active",
  "tags": [
    "string"
  ],
  "customFields": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Authorization

Path Parameters

Response

TypeScript