Skip to content

PracSuite API (v1)

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.

Download OpenAPI description
Overview
PracSuite API Support
License
Languages
Servers
Production
https://api.pracsuite.com/v1/

Appointment Book

SchemasOperations

Appointment

SchemasOperations

Note

SchemasOperations

Rule Out

SchemasOperations

Group Appointment

SchemasOperations

Group Appointment Member

SchemasOperations

Cancelled Appointment

SchemasOperations

Cancellation Reason

SchemasOperations

Reschedule Reason

SchemasOperations

Appointment Type

SchemasOperations

Appointment Status

SchemasOperations

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

Available Appointment

app_timestring^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}$

ISO 8601 local datetime in the tenant's timezone.

Example: "2026-01-01T12:05:30"
column_numberinteger
item_idinteger
item_group_idinteger or null
appointment_type_idinteger
practitioner_idinteger
business_idinteger
profession_idinteger
widthinteger
durationinteger
resource_idsArray of integers
practitioner_namestring
{ "app_time": "2026-01-01T12:05:30", "column_number": 0, "item_id": 0, "item_group_id": 0, "appointment_type_id": 0, "practitioner_id": 0, "business_id": 0, "profession_id": 0, "width": 0, "duration": 0, "resource_ids": [ 0 ], "practitioner_name": "string" }

List available appointment times

Request

Security
x-api-key and a-api-key
Query
fromstring(date)required

Cannot be more than 7 days before the to parameter and cannot be before the current date in the tenant's time zone.

Example: from=2026-01-01
tostring(date)required

Cannot be more than 7 days after the from parameter and cannot be before the current date in the tenant's time zone.

Example: to=2026-01-07
appointment_type_idintegerrequired
client_idinteger

Required if account_id is not null

account_idinteger
business_idsArray of integers
practitioner_idsArray of integers
profession_idsArray of integers
resource_idsArray of integers
manualboolean
Default true
onlineboolean
Default false
waiting_listboolean
Default false
distinct_timesboolean

Controls whether the same appointment time is returned when it is available with multiple practitioners.

When true, appointment times are deduplicated so each time is returned once, even if multiple practitioners are available at that time. One practitioner is selected automatically.

When false, the same time may be returned multiple times, once for each available practitioner.

Default true
bufferinteger

Minutes added to the current time when searching for availability. Only appointment times starting after now + buffer are returned.

Default 60
pageinteger>= 1
Example: page=1
page_sizeinteger[ 1 .. 200 ]
Example: page_size=50
curl -i -X GET \
  'https://api.pracsuite.com/v1/available_appointments?from=2026-01-01&to=2026-01-07&appointment_type_id=0&client_id=0&account_id=0&business_ids=0&practitioner_ids=0&profession_ids=0&resource_ids=0&manual=true&online=false&waiting_list=false&distinct_times=true&buffer=60&page=1&page_size=50' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
available_timesArray of objects(AvailableAppointment)
total_entriesinteger
linksobject
Response
application/json
{ "available_times": [ {} ], "total_entries": 0, "links": { "self": "https://api.pracsuite.com/v1/available_appointments?page=2&appointment_type_id=1&from=2025-01-01&to=2025-01-07", "previous": "https://api.pracsuite.com/v1/available_appointments?page=1&appointment_type_id=1&from=2025-01-01&to=2025-01-07", "next": "https://api.pracsuite.com/v1/available_appointments?page=3&appointment_type_id=1&from=2025-01-01&to=2025-01-07" } }

Get Next available appointment time

Request

Security
x-api-key and a-api-key
Query
fromstring(date)required

Cannot be more than 7 days before the to parameter and cannot be before the current date in the tenant's time zone.

Example: from=2026-01-01
tostring(date)required

Cannot be more than 7 days after the from parameter and cannot be before the current date in the tenant's time zone.

Example: to=2026-01-07
appointment_type_idintegerrequired
client_idinteger

Required if account_id is not null

account_idinteger
business_idsArray of integers
practitioner_idsArray of integers
profession_idsArray of integers
resource_idsArray of integers
manualboolean
Default true
onlineboolean
Default false
waiting_listboolean
Default false
bufferinteger

Minutes added to the current time when searching for availability. Only appointment times starting after now + buffer are returned.

Default 60
curl -i -X GET \
  'https://api.pracsuite.com/v1/next_available_appointment?from=2026-01-01&to=2026-01-07&appointment_type_id=0&client_id=0&account_id=0&business_ids=0&practitioner_ids=0&profession_ids=0&resource_ids=0&manual=true&online=false&waiting_list=false&buffer=60' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
available_timesArray of objects(AvailableAppointment)
total_entriesinteger
linksobject
Response
application/json
{ "available_times": [ {} ], "total_entries": 0, "links": { "self": "https://api.pracsuite.com/v1/next_available_appointment?page=2&appointment_type_id=1&from=2025-01-01&to=2025-01-07" } }

Available Group Appointment

SchemasOperations

Business

SchemasOperations

Fee Category

SchemasOperations

Health Fund

SchemasOperations

Invoice

SchemasOperations

Payment

SchemasOperations

Item

SchemasOperations

Item Group

SchemasOperations

Organisation

SchemasOperations

Patient

SchemasOperations

Patient Account

SchemasOperations

Patient Attachment

SchemasOperations

Patient Contact

SchemasOperations

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

Payer

SchemasOperations

Payer Contact

SchemasOperations

Practitioner

SchemasOperations

Practitioner Provider Number

SchemasOperations

Profession

SchemasOperations

Pronoun

SchemasOperations

Referrer

SchemasOperations

Referrer Type

SchemasOperations

Resource

SchemasOperations

Sex

SchemasOperations

Tag

SchemasOperations

Tag Category

SchemasOperations