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 Client Files

Required parameters Type Description
entity String Type of entity (Only client entity is supported currently)
primaryDomainKey String The guid of the entity e.g.clientId

 

Optional parameters Type Description
parentFolderId String The guid of the folder from which the files to be returned. If left blank it will return the files from root level
name String Can be used to retrieve a file or folder by name in the given parent folder

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/File/?primaryDomainKey=b39f1a2b-26cd-4edb-8278-6500f5dae9fa&entity=Client
Example response
{
   "files":[
      {
         "id":"45ae3de2-45a9-4f1e-9f35-6fc56d316991",
         "parentFolderId":"",
         "name":"Testfolder",
         "size":0,
         "status":"success",
         "isFolder":true,
         "primaryDomainKey":"b39f1a2b-26cd-4edb-8278-6500f5dae9fa"
      },
      {
         "id":"471ed7d1-e70c-4162-8fb8-d710cd94fa98",
         "parentFolderId":"",
         "name":"Bike.jpg",
         "size":256789,
         "status":"success",
         "isFolder":false,
         "primaryDomainKey":"b39f1a2b-26cd-4edb-8278-6500f5dae9fa"
      }
   ],
   "paging":{
      "totalRows":2,
      "pageNumber":1,
      "pageSize":50
   },
   "statusMessages":[
      
   ]
}

Develop with us

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


Please leave this field empty.