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.
PracSuite API (v1)
Download OpenAPI description
Overview
PracSuite API Support
License
Languages
Servers
Prod server
https://api.pracsuite.com/v1/
Business
{ "links": { "self": "https://api.pracsuite.com/v1/business/1", "appointment": "https://api.pracsuite.com/v1/business/1/appointment" }, "tenant_id": 1, "business_id": 123, "business_name": "string", "display_name": "string", "address_1": "string", "address_2": "string", "address_3": "string", "address_4": "string", "suburb": "string", "address_state": "string", "postcode": "string", "country": "string", "archive": false, "phone": "string", "fax": "string", "email": "user@example.com", "website": "http://example.com", "appointment_start_time": "14:15:22Z", "appointment_end_time": "14:15:22Z", "registration_number": "string", "registration_type": "string", "short_description": "string", "ndis_registration_number": "string" }
Query
Comma separated search fields
Example: sort_by=["business_id","business_name","display_name"]
- Prod serverhttps://api.pracsuite.com/v1/business
- cUrl
- JavaScript
- Node.js
- C#
- Python
- Java
curl -i -X GET \
'https://api.pracsuite.com/v1/business?page=1&page_size=50&sort_by=%5B%22business_id%22%2C%22business_name%22%2C%22display_name%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
{ "businesses": [ { … } ], "total_entries": 0, "links": { "self": "https://api.pracsuite.com/v1/business?page=2", "previous": "https://api.pracsuite.com/v1/business?page=1", "next": "https://api.pracsuite.com/v1/business?page=3" } }
- Prod serverhttps://api.pracsuite.com/v1/business/{business_id}
- cUrl
- JavaScript
- Node.js
- C#
- Python
- Java
curl -i -X GET \
'https://api.pracsuite.com/v1/business/{business_id}' \
-H 'A-api-key: YOUR_API_KEY_HERE' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "links": { "self": "https://api.pracsuite.com/v1/business/1", "appointment": "https://api.pracsuite.com/v1/business/1/appointment" }, "tenant_id": 1, "business_id": 123, "business_name": "string", "display_name": "string", "address_1": "string", "address_2": "string", "address_3": "string", "address_4": "string", "suburb": "string", "address_state": "string", "postcode": "string", "country": "string", "archive": false, "phone": "string", "fax": "string", "email": "user@example.com", "website": "http://example.com", "appointment_start_time": "14:15:22Z", "appointment_end_time": "14:15:22Z", "registration_number": "string", "registration_type": "string", "short_description": "string", "ndis_registration_number": "string" }
Patient
Patients are the people that book in for appointments.
When you're working with patient information, make sure you abide by the relevant regulations for security and privacy.
A couple of fields in the patient record deserve special consideration:
accepted_privacy_policy stores the patient's consent to the business's own privacy policy. Values can be null (no response), true (accepted) or false (rejected). Please consider how this may affect you storing information on this patient.
time_zone will contain a valid IANA time zone identifier if the patient's time zone has been set, or null if it hasn't. It can be set via the API, in which case it accepts IANA time zone identifiers.
SchemasOperations