This is the official PracSuite API.
It follows standard REST conventions, so you can work with it using any HTTP client and any programming language that can send HTTP requests.
All responses are returned in JSON format.
- Get Patient Contact
Patient Contact
List Patient Contacts
List Patient Contacts by Patient
Get Patient Contact
PracSuite API (v1)
Download OpenAPI description
Overview
PracSuite API Support
License
Languages
Servers
Production
https://api.pracsuite.com/v1/
Available Appointment
You may search for a maximum of 7 days of appointment availability per request.
All availability searches must specify a single appointment_type_id.
Availability may be filtered using any combination of business, practitioner, profession, or resource. When multiple filters are supplied, only times matching all provided criteria will be returned.
PracSuite users define daily practitioner availability using Rosters. Users can apply three availability flags to control which tools can book at particular times:
- Manual - Allows staff to manually book appointments during these times
- Online Booking - Allows these times to be booked through the PracSuite online booking system
- Waiting List - Allows the PracSuite waiting list to offer these times to patients
Use the manual, online, and waiting_list query parameters to filter available times based on these roster flags. If none of these parameters are supplied, only times available for manual bookings will be returned.
Users define default appointment duration rules per Appointment Type. These defaults may vary based on business, profession, practitioner, and client fee category, which is determined by the combination of client_id and account_id.
When available, client_id and account_id should be provided to ensure the correct Appointment Type default configuration is applied.
SchemasOperations
Patient Contact
{ "links": { "self": "https://api.pracsuite.com/v1/patient_contact/1" }, "tenant_id": 0, "patient_contact_id": 0, "client_id": 0, "relationship": "string", "title": "string", "first_name": "string", "surname": "string", "address_1": "string", "address_2": "string", "address_3": "string", "address_4": "string", "suburb": "string", "address_state": "string", "postcode": "string", "country": "string", "home_phone": "string", "work_phone": "string", "mobile": "string", "email": "string", "notes": "string", "fax": "string", "linked_client_id": 0, "linked_referrer_id": 0, "linked_payer_id": 0, "account_id": 0, "preferred_phone": "string", "archive": true }
Query
Comma separated search fields. See Sorting
Example: sort_by=["patient_contact_id", "client_id"]
- Productionhttps://api.pracsuite.com/v1/patient_contact
- cUrl
- Node.js
- Python
curl -i -X GET \
'https://api.pracsuite.com/v1/patient_contact?page=1&page_size=50&sort_by=%5B%22patient_contact_id%22%2C+%22client_id%22%5D&q%5B%5D=string' \
-H 'a-api-key: YOUR_API_KEY_HERE' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "patient_contacts": [ { … } ], "total_entries": 0, "links": { "self": "https://api.pracsuite.com/v1/patient_contact?page=2", "previous": "https://api.pracsuite.com/v1/patient_contact?page=1", "next": "https://api.pracsuite.com/v1/patient_contact?page=3" } }
- Productionhttps://api.pracsuite.com/v1/patient_contact/{patient_contact_id}
- cUrl
- Node.js
- Python
curl -i -X GET \
'https://api.pracsuite.com/v1/patient_contact/{patient_contact_id}' \
-H 'a-api-key: YOUR_API_KEY_HERE' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "row_num": 0, "total_rows": 0, "links": { "self": "https://api.pracsuite.com/v1/patient_contact/1" }, "tenant_id": 0, "patient_contact_id": 0, "client_id": 0, "relationship": "string", "title": "string", "first_name": "string", "surname": "string", "address_1": "string", "address_2": "string", "address_3": "string", "address_4": "string", "suburb": "string", "address_state": "string", "postcode": "string", "country": "string", "home_phone": "string", "work_phone": "string", "mobile": "string", "email": "string", "notes": "string", "fax": "string", "linked_client_id": 0, "linked_referrer_id": 0, "linked_payer_id": 0, "account_id": 0, "preferred_phone": "string", "archive": true }
Query
Comma separated search fields. See Sorting
Example: sort_by=["patient_contact_id"]
- Productionhttps://api.pracsuite.com/v1/patient/{client_id}/patient_contact
- cUrl
- Node.js
- Python
curl -i -X GET \
'https://api.pracsuite.com/v1/patient/{client_id}/patient_contact?page=1&page_size=50&sort_by=%5B%22patient_contact_id%22%5D&q%5B%5D=string' \
-H 'a-api-key: YOUR_API_KEY_HERE' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "patient_contacts": [ { … } ], "total_entries": 0, "links": { "self": "https://api.pracsuite.com/v1/patient/1/patient_contact?page=2", "previous": "https://api.pracsuite.com/v1/patient/1/patient_contact?page=1", "next": "https://api.pracsuite.com/v1/patient/1/patient_contact?page=3" } }
Clinical Note
Rich text HTML is supported with a safe, limited set of elements and inline styles. Any unsupported tags, attributes, or CSS are removed automatically.
Supported elements
p, br, strong, em, i, u, blockquote, ul, ol, li, div, span, table, thead, tbody, tfoot, tr, td, th, colgroup, col, caption, img (base64 images only)
Images
Images must be embedded as base64 data URIs. Only PNG, JPEG/JPG, GIF, and WebP image types are supported. External image URLs and other formats are not permitted.
Supported inline CSS
Common formatting and table layout styles are allowed, including text styling, alignment, spacing, borders, and table sizing (color, font-size, text-align, padding, width, height, border, etc.). Unsupported styles are removed automatically.
Content limits
Rich text content must be 150,000 characters or less after processing.
Operations