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 Referrers

Required parameters

Type

Description

isActive

Boolean

Status of the Referrer – True, False

True – Get list of Active Referrers

False – Get list of Inactive Referrers

hasActiveLocations

Boolean

Referrer with locations – True, False

True – Get list of Referrers who is assigned to a location

False – Get list of Referrers who is not assigned to a location

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

Example request URL: /Referrer/?isActive=&hasActiveLocations=&search=&orderBy=surname&orderByDirection=Asc&pageNumber=1&pageSize=2

Example response

{
   "count":481,
   "pageCount":241,
   "pageNumber":1,
   "pageSize":2,
   "referrers":[
      {
         "id":"5abcceac-0fdb-4c5a-93db-02549ba2fe3e",
         "title":"Dr",
         "firstName":"johnny",
         "lastName":"Auto_restapi",
         "active":true,
         "createdAt":"2019-06-11T14:05:50.963",
         "updatedAt":"2019-06-11T14:05:50.963"
      },
      {
         "id":"d95d2528-1cf8-499f-955f-b9f5261f6e1f",
         "title":"Dr",
         "firstName":"funny",
         "lastName":"Auto_restapi",
         "active":true,
         "createdAt":"2019-06-11T14:05:51.597",
         "updatedAt":"2019-06-11T14:05:51.597"
      }
   ]
}

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

coreplus API

Get List of Referrers

Develop with us