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@coreplus.com.au

Get An Appointment Record

Required parameters	Type	Description
appointmentId	String(50)	The Id of appointment to get

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Appointment/5dba9dc2-fecc-4fc3-b16f-6a09d6fbba75

Example response

{
   "appointment":{
      "appointmentId":"5dba9dc2-fecc-4fc3-b16f-6a09d6fbba75",
      "appointmentReferenceNumber":"4846396",
      "status":"Attended",
      "practitioner":{
         "practitionerId":"198f2d42-953b-441f-835e-0e4e15422824"
      },
      "subject":"ADAM Luke 0400000000",
      "notes":"",
      "locationId":"3c0639cc-0849-438e-b16e-aafd9548a0b8",
      "appointmentTypeId":"4aaa98e1-4bf6-44be-9f1e-eaf7d9a23a76",
      "startDateTime":"2021-09-07T09:00:00 +10:00",
      "endDateTime":"2021-09-07T09:30:00 +10:00",
      "clients":[
         {
            "clientId":"1a4d6238-1be7-4ea3-9436-8d67c2cccd6b"
         }
      ],
      "notifyPractitioner":false
   }
}

Optional parameters	Type	Description
getPractitionerProfiles	Boolean	Gets first name and last name of the practitioner the appointment is booked for
cancellationId	Boolean	Gets Cancellation Reason Id and Cancellation notes for the cancelled appointment

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Appointment/5dba9dc2-fecc-4fc3-b16f-6a09d6fbba75/?getPractitionerProfiles=true&CancellationId=true

Example response

{
   "appointment":{
      "appointmentId":"5dba9dc2-fecc-4fc3-b16f-6a09d6fbba75",
      "appointmentReferenceNumber":"4846396",
      "status":"Attended",
      "practitioner":{
         "practitionerId":"198f2d42-953b-441f-835e-0e4e15422824",
         "firstName":"George",
         "lastName":"Benn"
      },
      "subject":"ADAM Luke 0400000000",
      "notes":"",
      "cancellationReasonId": "6e256715-0c20-43dc-b60e-c3193e3577bb",    
      "cancellationNotes": "client cancelled due to his vacation",
      "locationId":"3c0639cc-0849-438e-b16e-aafd9548a0b8",
      "appointmentTypeId":"4aaa98e1-4bf6-44be-9f1e-eaf7d9a23a76",
      "startDateTime":"2021-09-07T09:00:00 +10:00",
      "endDateTime":"2021-09-07T09:30:00 +10:00",
      "clients":[
         {
            "clientId":"1a4d6238-1be7-4ea3-9436-8d67c2cccd6b"
         }
      ],
      "notifyPractitioner":false
   }
}

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

coreplus API

Get An Appointment Record

Develop with us