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 List of Client Family

Required parameters	Type	Description
clientId	Object containing Id	Id of the Client

Optional parameters	Type	Description
emergencyContact	Boolean	True – Returns only emergency family details for the client False – Returns non emergency family details for the client
pageNumber	int	Used for paging the list of client family – identify what page to get (default = 1)
pageSize	int	Used for paging the list of client family– identify the number of results per page (default = 50)

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/ClientFamily/?clientId=fe3b4575-2528-463b-b38a-cdbc8119be94

Example response

{
   "data":[
      {
         "surname":"sam",
         "familyId":"f9283788-51a1-4e6d-bdd5-b1ebec3247c1",
         "title":"Mr",
         "firstName":"rano",
         "dateOfBirth":"1992-04-18T00:00:00+10:00",
         "separatedDate":"2023-03-04T00:00:00+11:00",
         "relationship":"Boyfriend",
         "address":"22 silica ave",
         "suburb":"Maidstone",
         "postcode":"3012",
         "workPhone":"0300000000",
         "homePhone":"0300000000",
         "mobile":"0400000000",
         "email":"asder@bfriend.com",
         "notes":"this is some notes",
         "medicareCardNumber":"1234567888",
         "medicareCardIRN":"2",
         "emergencyContact":false,
         "invoiceRecipient":false,
         "mainContact":false,
         "separated":true
      },
      {
         "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
      }
   ],
   "total":2
}

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

coreplus API

Get List of Client Family

Develop with us