Sessions
List the appointments booked for your referrals, including scheduled, completed, cancelled and missed sessions.
A session is one appointment between a patient you referred and their physiotherapist. Use sessions to follow attendance in detail. For a summary, read the referral's sessions block or the progress report.
Session notes are never returned. The API exposes scheduling and attendance only.
The session object
{
"object": "session",
"id": "k97d4m2x8q1w5e3r7t9y6u0i2o4p6a8s",
"referral_id": "jd7f3k2m9x1q8w4e5r6t7y8u9i0o1p2a",
"tracking_code": "RHB-4829173655",
"partner_reference": "HMO-REF-2026-0091",
"sequence": 1,
"status": "completed",
"mode": "virtual",
"scheduled_start": "2026-10-15T10:00:00.000Z",
"scheduled_end": "2026-10-15T10:45:00.000Z",
"completed_at": "2026-10-15T10:45:00.000Z",
"provider": { "name": "Chiamaka Obi" },
"simulated": false
}| Field | Type | Description |
|---|---|---|
object | string | Always session. |
id | string | Session ID. |
referral_id | string | The id of the referral this session belongs to. |
tracking_code | string | The referral's tracking code. |
partner_reference | string or null | Your reference for the referral, if you sent one. |
sequence | integer | The session's position in the referral's care plan: 1 is the first session. |
status | string | scheduled, completed, cancelled or no_show. |
mode | string | virtual or in_person. |
scheduled_start, scheduled_end | string | ISO-8601 UTC. |
completed_at | string or null | When the session was completed. null unless status is completed. |
provider | object or null | { "name": "…" } for the physiotherapist. |
simulated | boolean | true for sandbox sessions, which are simulated from the referral's sandbox status. |
List sessions
GET /partners/sessionsReturns sessions for your referrals in the key's environment, newest first.
Query parameters
| Parameter | Type | Description |
|---|---|---|
referral_id | string | Only sessions for this referral. Accepts any referral identifier: id, tracking_code or your partner_reference. |
status | string | scheduled, completed, cancelled or no_show. |
from | string | ISO-8601 timestamp. Start of the time range, applied to scheduled_start. |
to | string | ISO-8601 timestamp. End of the time range, applied to scheduled_start. |
limit | integer | 1–100. Default 25. |
This endpoint doesn't use cursors: next_cursor is always null. If has_more is true, narrow the query with referral_id, status or a shorter from/to window.
curl "https://api.physioaroundme.com/v1/partners/sessions?referral_id=RHB-4829173655&status=completed" \
-H "Authorization: Bearer $REHABIFY_API_KEY"{
"object": "list",
"data": [
{
"object": "session",
"id": "k97h2j4k6l8z0x1c3v5b7n9m2q4w6e8r",
"referral_id": "jd7f3k2m9x1q8w4e5r6t7y8u9i0o1p2a",
"tracking_code": "RHB-4829173655",
"partner_reference": "HMO-REF-2026-0091",
"sequence": 2,
"status": "completed",
"mode": "in_person",
"scheduled_start": "2026-10-18T10:00:00.000Z",
"scheduled_end": "2026-10-18T10:45:00.000Z",
"completed_at": "2026-10-18T10:47:00.000Z",
"provider": { "name": "Chiamaka Obi" },
"simulated": false
},
{
"object": "session",
"id": "k97d4m2x8q1w5e3r7t9y6u0i2o4p6a8s",
"referral_id": "jd7f3k2m9x1q8w4e5r6t7y8u9i0o1p2a",
"tracking_code": "RHB-4829173655",
"partner_reference": "HMO-REF-2026-0091",
"sequence": 1,
"status": "completed",
"mode": "virtual",
"scheduled_start": "2026-10-15T10:00:00.000Z",
"scheduled_end": "2026-10-15T10:45:00.000Z",
"completed_at": "2026-10-15T10:45:00.000Z",
"provider": { "name": "Chiamaka Obi" },
"simulated": false
}
],
"has_more": false,
"next_cursor": null
}Errors: 400 invalid_parameter for an invalid status, from, to or limit, plus the standard authentication errors.
Sessions in sandbox
Sandbox never books real appointments. Sessions are simulated from the referral's sandbox status, so a referral you've advanced to booked or in_treatment shows plausible sessions. Every simulated session has "simulated": true.