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.

Current API Version

The current version of coreplus API is v2V2 will become obsolete on 30th September 2017.

The new v2.1 version and existing v2 are concurrently available on both the sandbox and production environments (version selection is made by URL), but soon v2 will no longer be available.

How to select API Version ?

The API version is nominated in API connection request URL and the matching URL in the JwToken as discussed in the authentication page. Here is an example of an API URL connecting to the schedule availability endpoint at the coreplus v2.1 API on the sandbox environment.

Sample URL: https://sandbox.coreplus.com.au/api/core/v2.1/AvailablitySlot/

Typically the API URL is of the following pattern:

https://[server domain name]/api/core/[version]/[end point]/[end point parameters]

The end point parameters may be optional depending on the end point and http method in use. See the documentation in this website for what is required for each endpoint.

For sandbox accounts the server domain is sandbox.coreplus.com.au and for production accounts the server domain is api.coreplus.com.au, which is what you will use when you have finished developing and wish to make  API calls to the live environment on your customer’s account. When you are ready to go live please contact support@coreplus.com.au to arrange live credentials and confirmation between coreplus and your customer regarding access.

Current and Future API Changes

A new version of coreplus API is available. The latest version V2.1

Major Changes (v2 to v2.1)

/appointment (Get):
1. Returns rescheduled and cancelled appointments.
2. Returns new parameter status (Rescheduled, Cancelled, No Show, Attended, Booked) as per appointment UI
3. If an appointment is private, returns subject as “This appointment has been marked as private” and will hide the appointment notes and client id

/client/id(Post):
1. Allows update of mobile phone number to be empty.

/availabilityslot (Get):
1. Include schedule occurrence filter, eg: every Nth week (fix for bug on v2)

For this and any other integration matters, please email support@coreplus.com.au

Develop with us

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


Please leave this field empty.