Skip to main content
Use this endpoint to fetch the full details of a recorded consent. The response includes the consent’s scope, status, verification record, and provision rules exactly as stored.

​
Request

GET https://api.clinikapi.com/v1/consents/:id

​
Headers

​
x-api-key
string
required
Your ClinikAPI secret key (clk_live_* or clk_test_*).

​
Path parameters

​
id
string
required
The consent ID to retrieve (e.g. consent_abc123).

​
Response

Returns 200 OK with the consent resource wrapped in the standard envelope.
​
data.id
string
The consent ID.
​
data.patientId
string
Patient reference.
​
data.scope
string
Consent scope: patient-privacy, treatment, research, or adr.
​
data.category
string | string[]
Consent category code(s).
​
data.status
string
Current status: draft, proposed, active, rejected, or inactive.
​
data.policyUri
string
URI of the referenced policy document, if recorded.
​
data.verification
object
Verification details, if recorded.
​
data.provision
object
Provision rules (permit/deny, period, purpose, action), if recorded.
​
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

​
Examples

​
curl

curl https://api.clinikapi.com/v1/consents/consent_abc123 \
  -H "x-api-key: clk_live_abc123"

​
TypeScript SDK

import { Clinik } from '@clinikapi/sdk';

const clinik = new Clinik(process.env.CLINIKAPI_SECRET_KEY!);

const { data } = await clinik.consents.read('consent_abc123');

console.log(data.scope);  // 'patient-privacy'
console.log(data.status); // 'active'