Skip to content
/
List Sexes

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
index.json
index.yaml
Overview
PracSuite API Support
helpdesk@pracsuite.com
License
MIT
Languages
Servers
Prod server
https://api.pracsuite.com/v1/

Appointment

SchemasOperations

Group Appointment

SchemasOperations

Group Appointment Member

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 Group Appointment

SchemasOperations

Business

SchemasOperations

Fee Category

SchemasOperations

Item

SchemasOperations

Item Group

SchemasOperations

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

Patient Account

Patient accounts

SchemasOperations

Practitioner

SchemasOperations

Profession

SchemasOperations

Pronoun

SchemasOperations

Resource

SchemasOperations

Sex

SchemasOperations

Sex

tenant_idinteger
sex_idinteger
descriptionstring
{
  "tenant_id": 0,
  "sex_id": 0,
  "description": "string"
}

List Sexes

Request

Security
x-api-key and A-api-key
Query
pageinteger>= 1
Example: page=1
page_sizeinteger[ 1 .. 100 ]
Example: page_size=50
sort_byArray of strings

Comma separated search fields

Example: sort_by=["sex_id","description"]
curl -i -X GET \
  'https://api.pracsuite.com/v1/sex?page=1&page_size=50&sort_by=%5B%22sex_id%22%2C%22description%22%5D' \
  -H 'A-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of all Sexes

Bodyapplication/json
sexesArray of objects(SexWithMeta)
total_entriesinteger
linksobject
Response
application/json
{
  "sexes": [
    { … }
  ],
  "total_entries": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/sex?page=2",
    "previous": "https://api.pracsuite.com/v1/sex?page=1",
    "next": "https://api.pracsuite.com/v1/sex?page=3"
  }
}