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 Client Family Record

Required parameters Type Description
familyId Object containing Id The Id of client family to get

 

Example request URL:  https://sandbox.coreplus.com.au/API/Core/v2/ClientFamily/3903326d-1dae-4c86-9d64-d1b929bc9247
Example response
{
         "surname":"ricky",
         "familyId":"3903326d-1dae-4c86-9d64-d1b929bc9247",
         "title":"Mx",
         "firstName":"marsh",
         "dateOfBirth":"1989-01-17T00:00:00+11:00",
         "relationship":"Father",
         "address":"eldridge street",
         "suburb":"Footscray",
         "postcode":"3011",
         "workPhone":"0300000000",
         "homePhone":"0300000000",
         "mobile":"0400000000",
         "email":"asder@father.com",
         "notes":"sample notes for this family",
         "medicareCardNumber":"1234567899",
         "medicareCardIRN":"1",
         "emergencyContact":true,
         "invoiceRecipient":true,
         "mainContact":true
      }

 

 

Develop with us

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


Please leave this field empty.