Skip to main content
Use this endpoint to fetch the full contents of a previously submitted intake form. The response includes all question-answer pairs exactly as stored, along with the intake’s status and patient context.

​
Request

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

​
Headers

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

​
Path parameters

​
id
string
required
The intake ID to retrieve (e.g. intake_abc123).

​
Response

Returns 200 OK with the intake resource wrapped in the standard envelope.
​
data.id
string
The intake ID.
​
data.patientId
string
Patient reference.
​
data.encounterId
string
Encounter reference, if recorded.
​
data.questionnaire
string
URI of the Questionnaire definition, if provided.
​
data.status
string
Current intake status: in-progress, completed, amended, or stopped.
​
data.authored
string
ISO 8601 timestamp of when the answers were gathered.
​
data.items
array
Structured question-answer pairs, including any nested sub-items.
​
meta
object
Standard response metadata including requestId, timestamp, status, and rate-limit fields.

​
Examples

​
curl

curl https://api.clinikapi.com/v1/intakes/intake_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.intakes.read('intake_abc123');

console.log(data.status); // 'completed'
console.log(data.items.length);