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.

Get An Appointment Record

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

 

Optional parameters None

 

Example request URL:  https://sandbox.coreplus.com.au/API/Core/v2/Appointment/4f0e23d4-1bf4-49d8-8cd6-8e68b8ba8631
Example response
{
    "appointment": {
        "appointmentId": "4f0e23d4-1bf4-49d8-8cd6-8e68b8ba8631",
        "appointmentReferenceNumber": "109513",
        "practitioner": {
            "practitionerId": "a630f4ad-8b4b-4e06-8cee-7db56ba8b9bf"
        },
        "subject": "Sim siren 0420000008",
        "notes": "",
        "locationId": "d8d4fe7c-765a-46a3-a389-54ce298a27e9",
        "appointmentTypeId": "6e74f531-6392-4b5a-b507-9f732c557778",
        "startDateTime": "2017-09-09T10:00:00 +10:00",
        "endDateTime": "2017-09-09T10:30:00 +10:00",
        "clients": [
            {
                "clientId": "a776074e-c80b-4640-b14f-23b0f1b0c0ef"
            }
        ],
        "notifyPractitioner": false
    }
}

Develop with us

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


Please leave this field empty.