{ "info": { "name": "PracticeHub API", "description": "The PracticeHub public REST API (`/v3/api`).\n\n**Getting started**\n\n1. Select the *PracticeHub — Local* or *PracticeHub — Production* environment (or edit the collection variables) and set `base_url` to `https://{clinic}.{region}.practicehub.io/v3/api` — the host the practice signs in on (region host: neptune London, mercury Frankfurt, vulcan Ohio, jupiter Singapore, apollo Sydney) — and `api_key` to a key from **Developers → API Keys**.\n2. Send **Utility → Me** — it confirms the key, its scopes and the account timezone.\n3. Send **List locations**, **List appointment types** and **List practitioners**; each stores the first id in `{{location_id}}`, `{{appointment_type_id}}`, `{{practitioner_id}}` for later requests.\n4. **Create patient** stores `{{patient_id}}`; **Find available slots** stores the first free slot; **Create appointment** books it.\n\nEvery resource folder follows the same shape: List (filter with `attribute=operator:value`, sort, paginate), Get, Create, Update (PATCH — send only the keys to change), Delete. Requests that need an id use `{{_id}}`, which List/Create fill in for you.\n\n**Safety:** requests with unset variables are not sent (see the Postman Console for what to run first). Update and Delete only act on a record created from this collection, or an id you type into the `:id` path variable — never on one List captured. Update bodies list every writable field as a template: remove what you do not want to change before sending.\n\nThe canonical PracticeHub REST API. Every clinic account is a tenant addressed by the host the practice signs in on: `https://{clinic}.{region}.practicehub.io` (region host `neptune` London, `mercury` Frankfurt, `vulcan` Ohio, `jupiter` Singapore, `apollo` Sydney).\n\n## Filtering\nList endpoints accept `?attribute=operator:value` with operators `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `null`, `not-null`, `like`, `contains`, `in`, `not-in`, `between` (`null`/`not-null` take no value; `in`, `not-in`, `between` take comma-separated values; `contains` is a case-insensitive substring match with no wildcards to escape). A value with no operator is an equality match. Only attributes marked filterable may be filtered (422 otherwise).\n\n## Metadata\nEvery record carries an integrator-owned `metadata` object of string, number or boolean values (max 50 keys). Send `metadata` on create/update to merge keys (`null` removes a key) and filter with `?metadata[key]=operator:value`.\n\n## Sorting & pagination\n`?sort=attr[,attr]:asc|desc` on sortable attributes; `?page=` and `?page_size=` (max 100). List responses wrap rows in `data` with `links` and `meta`.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const abort = (message) => {", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", "};", "const auth = pm.request.auth && pm.request.auth.type;", "if (auth !== 'noauth' && !pm.variables.get('api_key')) {", " abort('api_key is not set. Create a key under Developers → API Keys in PracticeHub and paste it into your Postman environment.');", "}", "const unresolved = new Set();", "const scan = (text) => {", " for (const match of String(text || '').matchAll(/\\{\\{([a-z_]+)\\}\\}/g)) {", " const value = pm.variables.get(match[1]);", " if (value === undefined || value === null || value === '') unresolved.add(match[1]);", " }", "};", "scan(pm.request.url.toString());", "if (pm.request.body && pm.request.body.raw) scan(pm.request.body.raw);", "if (pm.request.body && pm.request.body.formdata) pm.request.body.formdata.each((field) => scan(field.value));", "if (unresolved.size) {", " const names = [...unresolved].join(', ');", " abort(`Variable(s) not set: ${names}. Run the matching \"List …\" or \"Create …\" request first (it stores the id), or set them in your environment.`);", "}" ] } } ], "variable": [ { "key": "base_url", "value": "https://your-clinic.your-region.practicehub.io/v3/api", "type": "string" }, { "key": "api_key", "value": "", "type": "string" } ], "item": [ { "name": "Utility", "description": "Liveness, identity and discovery", "item": [ { "name": "Ping", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ping", "host": [ "{{base_url}}" ], "path": [ "ping" ] }, "description": "Liveness check\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "auth": { "type": "noauth" } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Me", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/me", "host": [ "{{base_url}}" ], "path": [ "me" ] }, "description": "Identify the authenticated credential and the account it reaches\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Schema — all resources", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/schema", "host": [ "{{base_url}}" ], "path": [ "schema" ] }, "description": "Describe every resource (attributes, filters, write operations, input)\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Schema — one resource", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/schema/:entity", "host": [ "{{base_url}}" ], "path": [ "schema", ":entity" ], "variable": [ { "key": "entity", "value": "patients", "description": "Resource name, e.g. patients" } ] }, "description": "Describe one resource\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "Locations", "description": "The locations resource", "item": [ { "name": "List locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/locations?page_size=25", "host": [ "{{base_url}}" ], "path": [ "locations" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "email", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "phone_number", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "website", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "shift_open", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "online_booking", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "feedback_url", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "feedback_rating_trigger", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "feedback_visit_trigger", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List locations\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('location_id')) scope.set('location_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get location", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/locations/:id", "host": [ "{{base_url}}" ], "path": [ "locations", ":id" ], "variable": [ { "key": "id", "value": "{{location_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of locations\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "AppointmentTypes", "description": "The appointment_types resource", "item": [ { "name": "List appointment types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/appointment_types?page_size=25", "host": [ "{{base_url}}" ], "path": [ "appointment_types" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, name, duration, modality_id, type, group_max_attendees, custom_order, updated, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "duration", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "color", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "columns", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "modality_id", "value": "{{modality_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "group_max_attendees", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "active", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "custom_order", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "online_booking", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List appointment_types\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('appointment_type_id')) scope.set('appointment_type_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get appointment type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/appointment_types/:id", "host": [ "{{base_url}}" ], "path": [ "appointment_types", ":id" ], "variable": [ { "key": "id", "value": "{{appointment_type_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of appointment_types\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "Practitioners", "description": "The practitioners resource", "item": [ { "name": "List practitioners", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/practitioners?page_size=25", "host": [ "{{base_url}}" ], "path": [ "practitioners" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, first_name, last_name, updated, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "first_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "last_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "active", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "columns", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "color", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "modality_id", "value": "{{modality_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "online_booking", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "slot_duration", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List practitioners\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('practitioner_id')) scope.set('practitioner_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get practitioner", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/practitioners/:id", "host": [ "{{base_url}}" ], "path": [ "practitioners", ":id" ], "variable": [ { "key": "id", "value": "{{practitioner_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of practitioners\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "Modalities", "description": "The modalities resource", "item": [ { "name": "List modalities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/modalities?page_size=25", "host": [ "{{base_url}}" ], "path": [ "modalities" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "active", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List modalities\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('modality_id')) scope.set('modality_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get modality", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/modalities/:id", "host": [ "{{base_url}}" ], "path": [ "modalities", ":id" ], "variable": [ { "key": "id", "value": "{{modality_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of modalities\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "ReferralSources", "description": "The referral_sources resource", "item": [ { "name": "List referral sources", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/referral_sources?page_size=25&visibility=all", "host": [ "{{base_url}}" ], "path": [ "referral_sources" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, name, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "active", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "visibility", "value": "all", "description": "Front-desk view (`all`) is on so slots come back for types not enabled for online booking; switch to `online` for the patient view. Filter: operator:value" }, { "key": "category", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "id_order", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List referral_sources\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('referral_source_id')) scope.set('referral_source_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create referral source", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/referral_sources", "host": [ "{{base_url}}" ], "path": [ "referral_sources" ] }, "description": "Create referral_sources\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `name` | string | |\n| `active` | integer | |\n| `visibility` | string | |\n| `category` | integer | |\n| `id_order` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Created from Postman\",\n \"active\": 1,\n \"visibility\": \"string\",\n \"category\": 1,\n \"id_order\": 1,\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('referral_source_id', id);", " scope.set('created_referral_source_id', id);", "}" ] } } ], "response": [] }, { "name": "Get referral source", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/referral_sources/:id", "host": [ "{{base_url}}" ], "path": [ "referral_sources", ":id" ], "variable": [ { "key": "id", "value": "{{referral_source_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of referral_sources\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update referral source", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/referral_sources/:id", "host": [ "{{base_url}}" ], "path": [ "referral_sources", ":id" ], "variable": [ { "key": "id", "value": "{{referral_source_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update referral_sources\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `name` | string | |\n| `active` | integer | |\n| `visibility` | string | |\n| `category` | integer | |\n| `id_order` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Created from Postman\",\n \"active\": 1,\n \"visibility\": \"string\",\n \"category\": 1,\n \"id_order\": 1,\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{referral_source_id}}') {", " const current = pm.variables.get('referral_source_id');", " const created = pm.variables.get('created_referral_source_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update referral_source ${current}: it was not created from this collection. Send \"Create referral source\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "PaymentMethods", "description": "The payment_methods resource", "item": [ { "name": "List payment methods", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payment_methods?page_size=25", "host": [ "{{base_url}}" ], "path": [ "payment_methods" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: active, sort_order, created, updated", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "active", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "sort_order", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List payment_methods\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('payment_method_id')) scope.set('payment_method_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create payment method", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/payment_methods", "host": [ "{{base_url}}" ], "path": [ "payment_methods" ] }, "description": "Create payment_methods\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `name` | string | |\n| `active` | boolean | |\n| `sort_order` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Created from Postman\",\n \"active\": false,\n \"sort_order\": 1,\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('payment_method_id', id);", " scope.set('created_payment_method_id', id);", "}" ] } } ], "response": [] }, { "name": "Get payment method", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payment_methods/:id", "host": [ "{{base_url}}" ], "path": [ "payment_methods", ":id" ], "variable": [ { "key": "id", "value": "{{payment_method_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of payment_methods\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update payment method", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payment_methods/:id", "host": [ "{{base_url}}" ], "path": [ "payment_methods", ":id" ], "variable": [ { "key": "id", "value": "{{payment_method_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update payment_methods\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `name` | string | |\n| `active` | boolean | |\n| `sort_order` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Created from Postman\",\n \"active\": false,\n \"sort_order\": 1,\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{payment_method_id}}') {", " const current = pm.variables.get('payment_method_id');", " const created = pm.variables.get('created_payment_method_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update payment_method ${current}: it was not created from this collection. Send \"Create payment method\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "Patients", "description": "The patients resource", "item": [ { "name": "List patients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patients?page_size=25", "host": [ "{{base_url}}" ], "path": [ "patients" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, dob, updated, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "imported_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "custom_reference", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "first_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "last_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "preferred_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "dob", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "email", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "sex", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "balance", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "private_balance", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "third_party_balance", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "communication_status", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_status", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "locale", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "referral_source_id", "value": "{{referral_source_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "referral_source_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "note", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "default_location", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "firebase_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "app_signup", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "app_last_accessed", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "blocked", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List patients\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('patient_id')) scope.set('patient_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/patients", "host": [ "{{base_url}}" ], "path": [ "patients" ] }, "description": "Create patients\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `first_name` | string | yes |\n| `last_name` | string | |\n| `preferred_name` | string | |\n| `dob` | date | |\n| `email` | email | |\n| `sex` | one of `male`, `female`, `other` | |\n| `note` | string | |\n| `custom_reference` | string | |\n| `locale` | string | |\n| `blocked` | boolean | |\n| `default_location` | integer | |\n| `referral_source_id` | integer | |\n| `referral_source_type` | one of `referral_source`, `patient` | |\n| `communication_preferences.marketing.push_notification` | boolean | |\n| `communication_preferences.transactional.push_notification` | boolean | |\n| `numbers` | array | |\n| `numbers[].number` | string | |\n| `numbers[].country_code` | string | |\n| `numbers[].iso2` | string | |\n| `numbers[].type` | one of `mobile`, `home`, `work`, `other` | |\n| `address.line1` | string | |\n| `address.line2` | string | |\n| `address.city` | string | |\n| `address.state` | string | |\n| `address.postcode` | string | |\n| `address.country` | string | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Ada\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('patient_id', id);", " scope.set('created_patient_id', id);", "}" ] } } ], "response": [] }, { "name": "Get patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patients/:id", "host": [ "{{base_url}}" ], "path": [ "patients", ":id" ], "variable": [ { "key": "id", "value": "{{patient_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of patients\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update patient", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patients/:id", "host": [ "{{base_url}}" ], "path": [ "patients", ":id" ], "variable": [ { "key": "id", "value": "{{patient_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update patients\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `first_name` | string | |\n| `last_name` | string | |\n| `preferred_name` | string | |\n| `dob` | date | |\n| `email` | email | |\n| `sex` | one of `male`, `female`, `other` | |\n| `note` | string | |\n| `custom_reference` | string | |\n| `locale` | string | |\n| `blocked` | boolean | |\n| `default_location` | integer | |\n| `referral_source_id` | integer | |\n| `referral_source_type` | one of `referral_source`, `patient` | |\n| `communication_preferences.marketing.push_notification` | boolean | |\n| `communication_preferences.transactional.push_notification` | boolean | |\n| `numbers` | array | |\n| `numbers[].id` | integer | |\n| `numbers[].number` | string | |\n| `numbers[].country_code` | string | |\n| `numbers[].iso2` | string | |\n| `numbers[].type` | one of `mobile`, `home`, `work`, `other` | |\n| `address.line1` | string | |\n| `address.line2` | string | |\n| `address.city` | string | |\n| `address.state` | string | |\n| `address.postcode` | string | |\n| `address.country` | string | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"preferred_name\": \"Ada\",\n \"dob\": \"1990-05-14\",\n \"email\": \"ada@example.com\",\n \"sex\": \"male\",\n \"note\": \"Created from Postman\",\n \"custom_reference\": \"string\",\n \"locale\": \"en\",\n \"blocked\": false,\n \"communication_preferences\": {\n \"marketing\": {\n \"push_notification\": false\n },\n \"transactional\": {\n \"push_notification\": false\n }\n },\n \"numbers\": [\n {\n \"number\": \"07700900123\",\n \"country_code\": \"44\",\n \"iso2\": \"GB\",\n \"type\": \"mobile\"\n }\n ],\n \"address\": {\n \"line1\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postcode\": \"string\",\n \"country\": \"string\"\n },\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{patient_id}}') {", " const current = pm.variables.get('patient_id');", " const created = pm.variables.get('created_patient_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update patient ${current}: it was not created from this collection. Send \"Create patient\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete patient", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patients/:id", "host": [ "{{base_url}}" ], "path": [ "patients", ":id" ], "variable": [ { "key": "id", "value": "{{patient_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete patients\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{patient_id}}') {", " const current = pm.variables.get('patient_id');", " const created = pm.variables.get('created_patient_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete patient ${current}: it was not created from this collection. Send \"Create patient\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('patient_id'); scope.unset('created_patient_id'); }" ] } } ], "response": [] } ] }, { "name": "Availability", "description": "Free, bookable slots — check before creating an appointment", "item": [ { "name": "Find available slots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/availability?location_id={{location_id}}&appointment_type_id={{appointment_type_id}}&visibility=all", "host": [ "{{base_url}}" ], "path": [ "availability" ], "query": [ { "key": "location_id", "value": "{{location_id}}", "description": "Location to search" }, { "key": "appointment_type_id", "value": "{{appointment_type_id}}", "description": "Appointment type to book" }, { "key": "practitioner_id", "value": "{{practitioner_id}}", "description": "Limit to one practitioner (omit for any)", "disabled": true }, { "key": "from", "value": "2026-09-01", "description": "Range start in the clinic timezone, `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS` (default: start of today)", "disabled": true }, { "key": "to", "value": "2026-09-07", "description": "Range end (inclusive; a date means the end of that day). Default 7 days from `from`; at most 31 days", "disabled": true }, { "key": "visibility", "value": "all", "description": "Front-desk view (`all`) is on so slots come back for types not enabled for online booking; switch to `online` for the patient view. Patient (`online`) or front-desk (`all`) view One of: online, all" }, { "key": "max_per_day", "value": "", "description": "Cap on slots returned per day", "disabled": true }, { "key": "rescheduled_appointment_id", "value": "", "description": "When finding a new time for an existing appointment: its occupied time is treated as free for overlapping alternatives (its duration/columns are used), but its exact current start is not offered", "disabled": true } ] }, "description": "List free, bookable slots for a location and appointment type\n\nComputed from the same availability engine as the calendar and online booking, so a returned slot is one the practice would book. `visibility=online` (default) is the patient view: the location, appointment type and (if given) practitioner must be enabled for online booking, and every online-booking rule applies — minimum advance notice, months ahead, daily caps, online-only guides, clustering. `visibility=all` is the front-desk view: every open slot for practitioners who provide the service, subject only to physical capacity. Up to 50 slots are returned per day. Not to be confused with `practitioner_availabilities`, which are the raw working-hours records this is computed from. Book a slot with `POST /appointments` (`start`/`end`/`practitioner_id`; `group_master_id` for a group slot).\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const slots = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (slots.length) {", " scope.set('slot_start', slots[0].start);", " scope.set('slot_end', slots[0].end);", " scope.set('slot_practitioner_id', slots[0].practitioner_id);", " console.log(`Stored first slot ${slots[0].start} with practitioner ${slots[0].practitioner_id} for Create appointment`);", "}" ] } } ], "response": [] } ] }, { "name": "Appointments", "description": "The appointments resource", "item": [ { "name": "List appointments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/appointments?page_size=25", "host": [ "{{base_url}}" ], "path": [ "appointments" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, appointment_type_id, practitioner_id, patient_id, location_id, status, updated, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "appointment_type_id", "value": "{{appointment_type_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "practitioner_id", "value": "{{practitioner_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "resource_id", "value": "{{resource_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "columns", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_id", "value": "{{patient_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "location_id", "value": "{{location_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "start", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "end", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "status", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "note", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "is_group", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "group_master_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "group_total_attendees", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "cancel_date", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "cancel_note", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List appointments\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('appointment_id')) scope.set('appointment_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create appointment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/appointments", "host": [ "{{base_url}}" ], "path": [ "appointments" ] }, "description": "Create appointments\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_id` | integer | yes |\n| `location_id` | integer | |\n| `appointment_type_id` | integer | yes |\n| `practitioner_id` | integer | |\n| `resource_id` | integer | |\n| `start` | string (Format Y-m-d H:i:s) | |\n| `end` | string (Format Y-m-d H:i:s) | |\n| `columns` | integer | |\n| `note` | string | |\n| `status` | one of `pending` | |\n| `cancel_note` | string | |\n| `cancel_reason_id` | integer | |\n| `group_master_id` | integer | |\n| `allow_clash` | boolean | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"patient_id\": {{patient_id}},\n \"location_id\": {{location_id}},\n \"appointment_type_id\": {{appointment_type_id}},\n \"practitioner_id\": {{slot_practitioner_id}},\n \"start\": \"{{slot_start}}\",\n \"end\": \"{{slot_end}}\",\n \"note\": \"Booked from Postman\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('appointment_id', id);", " scope.set('created_appointment_id', id);", "}" ] } } ], "response": [] }, { "name": "Get appointment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/appointments/:id", "host": [ "{{base_url}}" ], "path": [ "appointments", ":id" ], "variable": [ { "key": "id", "value": "{{appointment_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of appointments\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update appointment", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/appointments/:id", "host": [ "{{base_url}}" ], "path": [ "appointments", ":id" ], "variable": [ { "key": "id", "value": "{{appointment_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update appointments\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `location_id` | integer | |\n| `appointment_type_id` | integer | |\n| `practitioner_id` | integer | |\n| `resource_id` | integer | |\n| `start` | string (Format Y-m-d H:i:s) | |\n| `end` | string (Format Y-m-d H:i:s) | |\n| `columns` | integer | |\n| `note` | string | |\n| `status` | one of `pending`, `arrived`, `cancelled`, `missed` | |\n| `cancel_note` | string | |\n| `cancel_reason_id` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"start\": \"2026-09-01 09:00:00\",\n \"end\": \"2026-09-01 09:30:00\",\n \"columns\": 1,\n \"note\": \"Created from Postman\",\n \"status\": \"pending\",\n \"cancel_note\": \"string\",\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{appointment_id}}') {", " const current = pm.variables.get('appointment_id');", " const created = pm.variables.get('created_appointment_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update appointment ${current}: it was not created from this collection. Send \"Create appointment\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete appointment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/appointments/:id", "host": [ "{{base_url}}" ], "path": [ "appointments", ":id" ], "variable": [ { "key": "id", "value": "{{appointment_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete appointments\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{appointment_id}}') {", " const current = pm.variables.get('appointment_id');", " const created = pm.variables.get('created_appointment_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete appointment ${current}: it was not created from this collection. Send \"Create appointment\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('appointment_id'); scope.unset('created_appointment_id'); }" ] } } ], "response": [] } ] }, { "name": "Addresses", "description": "The addresses resource", "item": [ { "name": "List addresses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/addresses?page_size=25", "host": [ "{{base_url}}" ], "path": [ "addresses" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, created, updated", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "entity_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "entity_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "country", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "county_state", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "address_one", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "address_two", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "address_three", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "city", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "postcode", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List addresses\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('address_id')) scope.set('address_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get address", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/addresses/:id", "host": [ "{{base_url}}" ], "path": [ "addresses", ":id" ], "variable": [ { "key": "id", "value": "{{address_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of addresses\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "DeletedEntities", "description": "The deleted_entities resource", "item": [ { "name": "List deleted entities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/deleted_entities?page_size=25", "host": [ "{{base_url}}" ], "path": [ "deleted_entities" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, entity_type, entity_id, patient_id, created, updated, deleted", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "entity_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "entity_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_id", "value": "{{patient_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "deleted", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List deleted_entities\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('deleted_entity_id')) scope.set('deleted_entity_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get deleted entity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/deleted_entities/:id", "host": [ "{{base_url}}" ], "path": [ "deleted_entities", ":id" ], "variable": [ { "key": "id", "value": "{{deleted_entity_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of deleted_entities\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "Files", "description": "The files resource", "item": [ { "name": "List files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/files?page_size=25", "host": [ "{{base_url}}" ], "path": [ "files" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "size", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "file_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "entity_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "file_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "description", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "mime_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_id", "value": "{{patient_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_viewable", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List files\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('file_id')) scope.set('file_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/files", "host": [ "{{base_url}}" ], "path": [ "files" ] }, "description": "Create files\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_id` | integer | yes |\n| `type` | one of `generic`, `patient_profile`, `custom_content`, `diagnostic_image`, `patient_log` | yes |\n| `description` | string | |\n| `patient_viewable` | boolean | |\n| `patient_log_id` | integer | |\n| `file` | binary | yes |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "formdata", "formdata": [ { "key": "patient_id", "type": "text", "value": "{{patient_id}}" }, { "key": "type", "type": "text", "value": "generic" }, { "key": "description", "type": "text", "value": "Created from Postman", "disabled": true }, { "key": "patient_viewable", "type": "text", "value": "0", "disabled": true }, { "key": "patient_log_id", "type": "text", "value": "{{patient_log_id}}", "disabled": true }, { "key": "file", "type": "file", "src": "", "description": "Pick a file to upload" } ] } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('file_id', id);", " scope.set('created_file_id', id);", "}" ] } } ], "response": [] }, { "name": "Get file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/files/:id", "host": [ "{{base_url}}" ], "path": [ "files", ":id" ], "variable": [ { "key": "id", "value": "{{file_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of files\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update file", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/files/:id", "host": [ "{{base_url}}" ], "path": [ "files", ":id" ], "variable": [ { "key": "id", "value": "{{file_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update files\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `type` | one of `generic`, `custom_content`, `diagnostic_image` | |\n| `description` | string | |\n| `patient_viewable` | boolean | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"type\": \"generic\",\n \"description\": \"Created from Postman\",\n \"patient_viewable\": false,\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{file_id}}') {", " const current = pm.variables.get('file_id');", " const created = pm.variables.get('created_file_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update file ${current}: it was not created from this collection. Send \"Create file\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/files/:id", "host": [ "{{base_url}}" ], "path": [ "files", ":id" ], "variable": [ { "key": "id", "value": "{{file_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete files\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{file_id}}') {", " const current = pm.variables.get('file_id');", " const created = pm.variables.get('created_file_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete file ${current}: it was not created from this collection. Send \"Create file\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('file_id'); scope.unset('created_file_id'); }" ] } } ], "response": [] } ] }, { "name": "Invoices", "description": "The invoices resource", "item": [ { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/invoices?page_size=25", "host": [ "{{base_url}}" ], "path": [ "invoices" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, appointment_id, practitioner_id, location_id, patient_id, total, updated, created, number, state, invoice_date, balance", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "appointment_id", "value": "{{appointment_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "practitioner_id", "value": "{{practitioner_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "location_id", "value": "{{location_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_id", "value": "{{patient_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "total", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "third_party", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "number", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "state", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "invoice_date", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "note", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "subtotal", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "balance", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_balance", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "third_party_balance", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List invoices\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('invoice_id')) scope.set('invoice_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/invoices", "host": [ "{{base_url}}" ], "path": [ "invoices" ] }, "description": "Create invoices\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_id` | integer | yes |\n| `practitioner_id` | integer | |\n| `invoice_date` | date | |\n| `note` | string | |\n| `line_items` | array | yes |\n| `line_items[].description` | string | |\n| `line_items[].quantity` | number | |\n| `line_items[].price` | number | |\n| `line_items[].billable_item_id` | integer | |\n| `line_items[].provider_id` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"patient_id\": {{patient_id}},\n \"line_items\": [\n {\n \"description\": \"Created from Postman\",\n \"quantity\": 1,\n \"price\": 50\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('invoice_id', id);", " scope.set('created_invoice_id', id);", "}" ] } } ], "response": [] }, { "name": "Get invoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/invoices/:id", "host": [ "{{base_url}}" ], "path": [ "invoices", ":id" ], "variable": [ { "key": "id", "value": "{{invoice_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of invoices\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update invoice", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/invoices/:id", "host": [ "{{base_url}}" ], "path": [ "invoices", ":id" ], "variable": [ { "key": "id", "value": "{{invoice_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update invoices\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `practitioner_id` | integer | |\n| `invoice_date` | date | |\n| `note` | string | |\n| `line_items` | array | |\n| `line_items[].id` | integer | |\n| `line_items[].description` | string | |\n| `line_items[].quantity` | number | |\n| `line_items[].price` | number | |\n| `line_items[].billable_item_id` | integer | |\n| `line_items[].provider_id` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"invoice_date\": \"2026-09-01\",\n \"note\": \"Created from Postman\",\n \"line_items\": [\n {\n \"description\": \"Created from Postman\",\n \"quantity\": 1,\n \"price\": 50,\n \"billable_item_id\": 1,\n \"provider_id\": 1\n }\n ],\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{invoice_id}}') {", " const current = pm.variables.get('invoice_id');", " const created = pm.variables.get('created_invoice_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update invoice ${current}: it was not created from this collection. Send \"Create invoice\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete invoice", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/invoices/:id", "host": [ "{{base_url}}" ], "path": [ "invoices", ":id" ], "query": [ { "key": "void_payments", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "{{invoice_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete invoices\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{invoice_id}}') {", " const current = pm.variables.get('invoice_id');", " const created = pm.variables.get('created_invoice_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete invoice ${current}: it was not created from this collection. Send \"Create invoice\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('invoice_id'); scope.unset('created_invoice_id'); }" ] } } ], "response": [] } ] }, { "name": "LineItems", "description": "The line_items resource", "item": [ { "name": "List line items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/line_items?page_size=25", "host": [ "{{base_url}}" ], "path": [ "line_items" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, invoice_id, provider_id, price, tax_amount, subtotal, total, updated, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "invoice_id", "value": "{{invoice_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "billable_item_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "provider_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "provider_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "description", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "quantity", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "currency", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "price", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "tax_amount", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "subtotal", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "total", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List line_items\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('line_item_id')) scope.set('line_item_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create line item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/line_items", "host": [ "{{base_url}}" ], "path": [ "line_items" ] }, "description": "Create line_items\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `invoice_id` | integer | yes |\n| `description` | string | |\n| `quantity` | number | |\n| `price` | number | |\n| `billable_item_id` | integer | |\n| `provider_id` | integer | |\n| `lines` | array | |\n| `lines[].description` | string | |\n| `lines[].quantity` | number | |\n| `lines[].price` | number | |\n| `lines[].billable_item_id` | integer | |\n| `lines[].provider_id` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"invoice_id\": {{invoice_id}}\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('line_item_id', id);", " scope.set('created_line_item_id', id);", "}" ] } } ], "response": [] }, { "name": "Get line item", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/line_items/:id", "host": [ "{{base_url}}" ], "path": [ "line_items", ":id" ], "variable": [ { "key": "id", "value": "{{line_item_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of line_items\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update line item", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/line_items/:id", "host": [ "{{base_url}}" ], "path": [ "line_items", ":id" ], "variable": [ { "key": "id", "value": "{{line_item_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update line_items\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `description` | string | |\n| `quantity` | number | |\n| `price` | number | |\n| `billable_item_id` | integer | |\n| `provider_id` | integer | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"description\": \"Created from Postman\",\n \"quantity\": 1,\n \"price\": 50,\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{line_item_id}}') {", " const current = pm.variables.get('line_item_id');", " const created = pm.variables.get('created_line_item_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update line_item ${current}: it was not created from this collection. Send \"Create line item\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete line item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/line_items/:id", "host": [ "{{base_url}}" ], "path": [ "line_items", ":id" ], "variable": [ { "key": "id", "value": "{{line_item_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete line_items\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{line_item_id}}') {", " const current = pm.variables.get('line_item_id');", " const created = pm.variables.get('created_line_item_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete line_item ${current}: it was not created from this collection. Send \"Create line item\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('line_item_id'); scope.unset('created_line_item_id'); }" ] } } ], "response": [] } ] }, { "name": "Numbers", "description": "The numbers resource", "item": [ { "name": "List numbers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/numbers?page_size=25", "host": [ "{{base_url}}" ], "path": [ "numbers" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "phone_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "phone_number", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "intl_number", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "intl_derived", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "entity_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "entity_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "iso2", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "country_code", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List numbers\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('number_id')) scope.set('number_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/numbers/:id", "host": [ "{{base_url}}" ], "path": [ "numbers", ":id" ], "variable": [ { "key": "id", "value": "{{number_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of numbers\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "PatientLogTags", "description": "The patient_log_tags resource", "item": [ { "name": "List patient log tags", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_log_tags?page_size=25", "host": [ "{{base_url}}" ], "path": [ "patient_log_tags" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: patient_log_tag_id, created_at, updated_at, patient_log_id, tag_name", "disabled": true }, { "key": "patient_log_tag_id", "value": "{{patient_log_tag_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "created_at", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated_at", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_log_id", "value": "{{patient_log_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "tag_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List patient_log_tags\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('patient_log_tag_id')) scope.set('patient_log_tag_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create patient log tag", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/patient_log_tags", "host": [ "{{base_url}}" ], "path": [ "patient_log_tags" ] }, "description": "Create patient_log_tags\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_log_id` | integer | yes |\n| `tag_name` | string | yes |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"patient_log_id\": {{patient_log_id}},\n \"tag_name\": \"postman\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('patient_log_tag_id', id);", " scope.set('created_patient_log_tag_id', id);", "}" ] } } ], "response": [] }, { "name": "Get patient log tag", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_log_tags/:id", "host": [ "{{base_url}}" ], "path": [ "patient_log_tags", ":id" ], "variable": [ { "key": "id", "value": "{{patient_log_tag_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of patient_log_tags\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update patient log tag", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_log_tags/:id", "host": [ "{{base_url}}" ], "path": [ "patient_log_tags", ":id" ], "variable": [ { "key": "id", "value": "{{patient_log_tag_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update patient_log_tags\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_log_id` | integer | |\n| `tag_name` | string | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"tag_name\": \"postman\",\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{patient_log_tag_id}}') {", " const current = pm.variables.get('patient_log_tag_id');", " const created = pm.variables.get('created_patient_log_tag_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update patient_log_tag ${current}: it was not created from this collection. Send \"Create patient log tag\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete patient log tag", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_log_tags/:id", "host": [ "{{base_url}}" ], "path": [ "patient_log_tags", ":id" ], "variable": [ { "key": "id", "value": "{{patient_log_tag_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete patient_log_tags\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{patient_log_tag_id}}') {", " const current = pm.variables.get('patient_log_tag_id');", " const created = pm.variables.get('created_patient_log_tag_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete patient_log_tag ${current}: it was not created from this collection. Send \"Create patient log tag\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('patient_log_tag_id'); scope.unset('created_patient_log_tag_id'); }" ] } } ], "response": [] } ] }, { "name": "PatientLogs", "description": "The patient_logs resource", "item": [ { "name": "List patient logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_logs?page_size=25", "host": [ "{{base_url}}" ], "path": [ "patient_logs" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_id", "value": "{{patient_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "sub_type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "source", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "source_entity", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "data", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List patient_logs\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('patient_log_id')) scope.set('patient_log_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create patient log", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/patient_logs", "host": [ "{{base_url}}" ], "path": [ "patient_logs" ] }, "description": "Create patient_logs\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_id` | integer | yes |\n| `type` | string | yes |\n| `sub_type` | string | yes |\n| `source_entity` | string | yes |\n| `data` | string | yes |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"patient_id\": {{patient_id}},\n \"type\": \"string\",\n \"sub_type\": \"string\",\n \"source_entity\": \"string\",\n \"data\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('patient_log_id', id);", " scope.set('created_patient_log_id', id);", "}" ] } } ], "response": [] }, { "name": "Get patient log", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_logs/:id", "host": [ "{{base_url}}" ], "path": [ "patient_logs", ":id" ], "variable": [ { "key": "id", "value": "{{patient_log_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of patient_logs\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update patient log", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_logs/:id", "host": [ "{{base_url}}" ], "path": [ "patient_logs", ":id" ], "variable": [ { "key": "id", "value": "{{patient_log_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update patient_logs\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_id` | integer | |\n| `type` | string | |\n| `sub_type` | string | |\n| `source_entity` | string | |\n| `data` | string | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"type\": \"string\",\n \"sub_type\": \"string\",\n \"source_entity\": \"string\",\n \"data\": \"string\",\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{patient_log_id}}') {", " const current = pm.variables.get('patient_log_id');", " const created = pm.variables.get('created_patient_log_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update patient_log ${current}: it was not created from this collection. Send \"Create patient log\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete patient log", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/patient_logs/:id", "host": [ "{{base_url}}" ], "path": [ "patient_logs", ":id" ], "variable": [ { "key": "id", "value": "{{patient_log_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete patient_logs\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{patient_log_id}}') {", " const current = pm.variables.get('patient_log_id');", " const created = pm.variables.get('created_patient_log_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete patient_log ${current}: it was not created from this collection. Send \"Create patient log\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('patient_log_id'); scope.unset('created_patient_log_id'); }" ] } } ], "response": [] } ] }, { "name": "PaymentAllocations", "description": "The payment_allocations resource", "item": [ { "name": "List payment allocations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payment_allocations?page_size=25", "host": [ "{{base_url}}" ], "path": [ "payment_allocations" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, amount, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "payment_id", "value": "{{payment_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "invoice_id", "value": "{{invoice_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_id", "value": "{{patient_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "amount", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List payment_allocations\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('payment_allocation_id')) scope.set('payment_allocation_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create payment allocation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/payment_allocations", "host": [ "{{base_url}}" ], "path": [ "payment_allocations" ] }, "description": "Create payment_allocations\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_id` | integer | yes |\n| `invoice_id` | integer | yes |\n| `payment_id` | integer | yes |\n| `amount` | number | yes |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"patient_id\": {{patient_id}},\n \"invoice_id\": {{invoice_id}},\n \"payment_id\": {{payment_id}},\n \"amount\": 50\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('payment_allocation_id', id);", " scope.set('created_payment_allocation_id', id);", "}" ] } } ], "response": [] }, { "name": "Get payment allocation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payment_allocations/:id", "host": [ "{{base_url}}" ], "path": [ "payment_allocations", ":id" ], "variable": [ { "key": "id", "value": "{{payment_allocation_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of payment_allocations\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete payment allocation", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payment_allocations/:id", "host": [ "{{base_url}}" ], "path": [ "payment_allocations", ":id" ], "variable": [ { "key": "id", "value": "{{payment_allocation_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete payment_allocations\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{payment_allocation_id}}') {", " const current = pm.variables.get('payment_allocation_id');", " const created = pm.variables.get('created_payment_allocation_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete payment_allocation ${current}: it was not created from this collection. Send \"Create payment allocation\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('payment_allocation_id'); scope.unset('created_payment_allocation_id'); }" ] } } ], "response": [] } ] }, { "name": "Payments", "description": "The payments resource", "item": [ { "name": "List payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payments?page_size=25", "host": [ "{{base_url}}" ], "path": [ "payments" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, amount, payment_type_id, patient_id, location_id, updated, created, payment_date, status", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "amount", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "payment_type_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "patient_id", "value": "{{patient_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "location_id", "value": "{{location_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "service", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "service_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "third_party", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "third_party_id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "note", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "payment_date", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "status", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List payments\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('payment_id')) scope.set('payment_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Create payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.", "disabled": true } ], "url": { "raw": "{{base_url}}/payments", "host": [ "{{base_url}}" ], "path": [ "payments" ] }, "description": "Create payments\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `patient_id` | integer | yes |\n| `amount` | number | yes |\n| `payment_type_id` | integer | yes |\n| `location_id` | integer | |\n| `service` | string | |\n| `service_id` | string | |\n| `note` | string | |\n| `payment_date` | date | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"patient_id\": {{patient_id}},\n \"amount\": 50,\n \"payment_type_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 201', () => pm.response.to.have.status(201));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 201) {", " const id = pm.response.json().data.id;", " scope.set('payment_id', id);", " scope.set('created_payment_id', id);", "}" ] } } ], "response": [] }, { "name": "Get payment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payments/:id", "host": [ "{{base_url}}" ], "path": [ "payments", ":id" ], "variable": [ { "key": "id", "value": "{{payment_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of payments\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Update payment", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payments/:id", "host": [ "{{base_url}}" ], "path": [ "payments", ":id" ], "variable": [ { "key": "id", "value": "{{payment_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Update payments\n\n**Fields**\n\n| Field | Type | Required |\n| --- | --- | --- |\n| `amount` | number | |\n| `payment_type_id` | integer | |\n| `note` | string | |\n| `payment_date` | date | |\n| `metadata` | object of string/number/boolean | |\n\nFull reference: `GET {{base_url}}/schema/` or the API docs.", "body": { "mode": "raw", "raw": "{\n \"amount\": 50,\n \"note\": \"Created from Postman\",\n \"payment_date\": \"2026-09-01\",\n \"metadata\": {\n \"source\": \"postman\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{payment_id}}') {", " const current = pm.variables.get('payment_id');", " const created = pm.variables.get('created_payment_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to update payment ${current}: it was not created from this collection. Send \"Create payment\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] }, { "name": "Delete payment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/payments/:id", "host": [ "{{base_url}}" ], "path": [ "payments", ":id" ], "variable": [ { "key": "id", "value": "{{payment_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Delete payments\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const raw = pm.request.url.variables.get('id');", "if (raw === '{{payment_id}}') {", " const current = pm.variables.get('payment_id');", " const created = pm.variables.get('created_payment_id');", " if (!created || String(current) !== String(created)) {", " const message = `Refusing to delete payment ${current}: it was not created from this collection. Send \"Create payment\" first, or type the id into the :id path variable to target a specific record deliberately.`;", " console.error(message);", " if (pm.execution && pm.execution.skipRequest) pm.execution.skipRequest();", " throw new Error(message);", " }", "}" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 204', () => pm.response.to.have.status(204));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "if (pm.response.code === 204) { scope.unset('payment_id'); scope.unset('created_payment_id'); }" ] } } ], "response": [] } ] }, { "name": "PractitionerAvailabilities", "description": "The practitioner_availabilities resource", "item": [ { "name": "List practitioner availabilities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/practitioner_availabilities?page_size=25", "host": [ "{{base_url}}" ], "path": [ "practitioner_availabilities" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "type", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "start", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "end", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "day", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "online_booking", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "description", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "color", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "columns", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "resource_id", "value": "{{resource_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "span_all_columns", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "practitioner_id", "value": "{{practitioner_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "location_id", "value": "{{location_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List practitioner_availabilities\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('practitioner_availability_id')) scope.set('practitioner_availability_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get practitioner availability", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/practitioner_availabilities/:id", "host": [ "{{base_url}}" ], "path": [ "practitioner_availabilities", ":id" ], "variable": [ { "key": "id", "value": "{{practitioner_availability_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of practitioner_availabilities\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] }, { "name": "Resources", "description": "The resources resource", "item": [ { "name": "List resources", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/resources?page_size=25", "host": [ "{{base_url}}" ], "path": [ "resources" ], "query": [ { "key": "page", "value": "1", "description": "", "disabled": true }, { "key": "page_size", "value": "25", "description": "" }, { "key": "cursor", "value": "", "description": "Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.", "disabled": true }, { "key": "sort", "value": "", "description": "attr[,attr]:asc|desc — sortable: id, name, display_order, updated, created", "disabled": true }, { "key": "id", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "location_id", "value": "{{location_id}}", "description": "Filter: operator:value", "disabled": true }, { "key": "name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "public_name", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "description", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "color", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "display_order", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "status", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "locked", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "updated", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "created", "value": "eq:", "description": "Filter: operator:value", "disabled": true }, { "key": "metadata[key]", "value": "", "description": "Filter by integrator metadata: metadata[key]=operator:value", "disabled": true } ] }, "description": "List resources\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));", "const scope = pm.environment.name ? pm.environment : pm.collectionVariables;", "const rows = pm.response.code === 200 ? (pm.response.json().data || []) : [];", "if (rows.length && !pm.variables.get('resource_id')) scope.set('resource_id', rows[0].id);" ] } } ], "response": [] }, { "name": "Get resource", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/resources/:id", "host": [ "{{base_url}}" ], "path": [ "resources", ":id" ], "variable": [ { "key": "id", "value": "{{resource_id}}", "description": "Set automatically by List/Create, or type an id" } ] }, "description": "Get one of resources\n\nFull reference: `GET {{base_url}}/schema/` or the API docs." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('Status is 200', () => pm.response.to.have.status(200));" ] } } ], "response": [] } ] } ] }