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 List of Clinics

Required parameters Type Description
isActive Boolean Status of the Clinic – True, False

True – Get list of Active Clinic

False – Get list of Inactive Clinic

 

Optional parameters Type Description
search String Get list of Clinics with clinic name matching the search term
orderBy String Order the list of Clinics using – clinicname
orderByDirection String Order the list of Clinics either ascending or descending – Asc, Desc
pageNumber Int Used for paging the list of Clinics – identify what page to get (default = 1)
pageSize Int Used for paging the list of Clinics – identify the number of results per page (default = 10)

 

Example request URL: /Clinic/?isActive=&search=&orderBy=clinicname&orderByDirection=Asc&pageNumber=1&pageSize=2
Example response
{
   "count":1388,
   "pageCount":694,
   "pageNumber":1,
   "pageSize":2,
   "clinics":[
      {
         "id":"87935659-124f-4b43-a403-5a15a311d6c4",
         "name":"wassa practise",
         "active":true,
         "createdAt":"2019-02-27T10:02:05.363",
         "updatedAt":"2019-02-27T10:02:05.367"
      },
      {
         "id":"21e1b5a2-7e8e-4a01-9ad6-26248dbc0ec0",
         "name":"wasky Clinic",
         "street":"21 wasky avenue",
         "suburb":"South Melbourne",
         "postCode":"3001",
         "state":"VIC",
         "phone":"0300000000",
         "fax":"0300000000",
         "email":"contact@apiexplorerclinic.com.au",
         "contactName":"Michael Munro",
         "active":true,
         "createdAt":"2019-06-11T14:51:36.01",
         "updatedAt":"2019-06-11T15:11:06.893"
      }
   ]
}

Develop with us

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


Please leave this field empty.