coreplus API

The coreplus API provides access to appointment booking related end points, such as clients, practitioners, availability slots and appointments. It is a RESTful API, which utilises the HTTP verbs for creating viewing objects.

If you are a developer looking to create an external consumer server to server application for your coreplus clients, then by signing up for a sandbox account you will get access to your own trial coreplus account on our sandbox server with authorisation credentials.

If you have any questions regarding the API documentation, please do not hesitate to contact us at integrations@corepluspm.com

Create Appointment Type

URL	`https://<server domain name>/api/core/<version>/appointmenttype/`
Methods Supported	POST
Description	Create Appointmet Type

Required parameters	Type	Description
description	string	Name of the Appointment Type

URL	`https://sandbox.coreplus.com.au/API/Core/v2/appointmenttype`
Example request	`{ "description":"Special Consult" }`
Example response	`{ "appointmentTypeId":"0396fdd1-6fbf-4409-b363-eb43dba71cb0", "description":"Special Consult" }`

Optional parameters	Type	Description
blockColour	String	Appointment Type color in Hex code format Ex: FF5733
durationMinutes	String	Appointment Type duration in minutes. Note: Duration cannot be more than 120 minutes
practitionerId	String	The id of the Practitioner
locationId	String	The id of the Location
clientGroupId	String	The id of the Client Group

URL https://sandbox.coreplus.com.au/API/Core/v2/appointmenttype/

Example request

{
   "description":"General Consultation",
   "blockColour":"#FF0000",
   "durationMinutes":"60",
   "practitionerId":"a630f4ad-8b4b-4e06-8cee-7db56ba8b9bf",
   "locationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
   "clientGroupId":"fdb489c1-a9ba-e611-8158-0202e207ce0b"
}

Example response

{
   "appointmentTypeId":"d8736ffc-5b24-44f7-81e3-7a550bd43a55",
   "description":"General Consultation"
}

Use the form to sign-up and start developing with coreplus today.

coreplus API

Create Appointment Type

Develop with us