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

Practitioner

URL	`https://<server domain name>/api/core/<version>/Practitioner/`
Methods Supported	GET
Description	Retrieves a list practitioners

Required parameters

None

Optional parameters	Type	Description
getSubspecialties	Boolean	Flag to determine whether each practitioner’s sub-specialties should be included in the response (true/false)
getAppointmentTypes	Boolean	Flag to determine whether the appointment types associated with the practitioner’s specialties should be included in the response. (true/false)
pId	String	The Id of the practitioner to get
pageNumber	Int	Used for paging the list of practitioners – identify what page to get (default = 1)
pageSize	Int	Used for paging the list of practitioners – identify the number of results per page (default = 50)

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Practitioner/?getSubSpecialties=true&getAppointmentTypes=true

Example response

{
   "practitioners":[
      {
         "practitionerId":"3dc6e75d-20b6-42bf-bb72-193ce9da85fc",
         "firstName":"Test",
         "lastName":"Practitioner",
         "email":"test.prac@email.com.au",
         "gender":"",
         "imageId":"13f5b125-1b06-4dcc-9bee-23a6de86369c",
         "description":"Practitioner profile description",
         "defaultViewingTimeZone":{
            "timezoneId":"39d62534-501c-49cd-9da9-6fa8d6a81f48",
            "tzName":"Australia\\Melbourne"
         },
         "specialties":[
            {
               "specialtyTypeId":"6af5f392-827c-49c4-9c12-9264e848fc18",
               "name":"Chripractic",
               "subSpecialties":[ ],
               "appointmentTypes":[
                  {
                     "appointmentTypeId":"a8f1c401-32ad-44a1-8177-97149248b8f6",
                     "description":"Consultation",
                     "durationMinutes":60
                  }
               ]
            }
         ]
      },
      {
         "practitionerId":"f2542365-6fc0-4289-8911-2dec8201bdd6",
         "firstName":"Practitioner",
         "lastName":"Prac Surname",
         "email":"testemail2@email.com.au",
         "gender":"Male",
         "imageId":"699e518f-baef-4b2c-9fae-5241fa5ef49f",
         "description":"test prac 2 description",
         "defaultViewingTimeZone":{
            "timezoneId":"5678c71f-7161-4e77-abe4-9337790e3996",
            "tzName":"Australia\\Adelaide"
         },
         "specialties":[
            {
               "specialtyTypeId":"6af5f392-827c-49c4-9c12-9264e848fc18",
               "name":"Chripractic",
               "subSpecialties":[ ],
               "appointmentTypes":[
                  {
                     "appointmentTypeId":"a8f1c401-32ad-44a1-8177-97149248b8f6",
                     "description":"Consultation",
                     "durationMinutes":60
                  }
               ]
            }
         ]
      }
   ],
   "paging": {
        "totalRows": 2,
        "pageNumber": 1,
        "pageSize": 50
    },
    "statusMessages": [ ]
}

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

coreplus API

Practitioner

Develop with us