Skip to content
/
List Resources by Appoint...

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

test

SchemasOperations

Appointment Type

test

SchemasOperations

Available Appointment

Avaiasldfsdflsd

SchemasOperations

Available Group Appointment

Avaiasldfsdflsd

SchemasOperations

Business

sdfsfd

SchemasOperations

Fee Category

sdfsfd

SchemasOperations

Item

sdfsfd

SchemasOperations

Item Group

sdfsfd

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

Practitioner

test

SchemasOperations

Profession

test

SchemasOperations

Pronoun

test

SchemasOperations

Resource

test

SchemasOperations

Resource

tenant_idinteger
resource_idinteger
descriptionstring
resource_rankinteger
archivedboolean
{
  "tenant_id": 0,
  "resource_id": 0,
  "description": "string",
  "resource_rank": 0,
  "archived": true
}

List Resources

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=["resource_id","description","resource_rank"]
curl -i -X GET \
  'https://api.pracsuite.com/v1/resource?page=1&page_size=50&sort_by=%5B%22resource_id%22%2C%22description%22%2C%22resource_rank%22%5D' \
  -H 'A-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of resources

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

Get Resource

Request

Security
x-api-key and A-api-key
Path
resource_idintegerrequired
curl -i -X GET \
  'https://api.pracsuite.com/v1/resource/{resource_id}' \
  -H 'A-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
tenant_idinteger
resource_idinteger
descriptionstring
resource_rankinteger
archivedboolean
Response
application/json
{
  "tenant_id": 0,
  "resource_id": 0,
  "description": "string",
  "resource_rank": 0,
  "archived": true
}

List Resources by Appointment

Request

Security
x-api-key and A-api-key
Path
appointment_idintegerrequired
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=["resource_id","description","resource_rank"]
curl -i -X GET \
  'https://api.pracsuite.com/v1/appointment/{appointment_id}/resource?page=1&page_size=50&sort_by=%5B%22resource_id%22%2C%22description%22%2C%22resource_rank%22%5D' \
  -H 'A-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of resources

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

List Resources by Appointment Type

Request

Security
x-api-key and A-api-key
Path
appointment_type_idintegerrequired
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=["resource_id","description","resource_rank"]
curl -i -X GET \
  'https://api.pracsuite.com/v1/appointment_type/{appointment_type_id}/resource?page=1&page_size=50&sort_by=%5B%22resource_id%22%2C%22description%22%2C%22resource_rank%22%5D' \
  -H 'A-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of resources

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

Sex

test

SchemasOperations