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.

Client Folder

URL https://<server domain name>/api/core/<version>/Folder/
Methods Supported POST

*Note that folder get is done through the files endpoint

Description Create a folder in the client’s file structure
Permission Access to this endpoint requires a Permission

 

Required parameters Type Description
Entity String Entity to which the file is assigned. Just “client” is currently supported
Name String Name of Folder you are creating
IsFolder Bool Indicates you are creating a folder should be set to TRUE
primaryDomainKey String The entity’s guid, ie the clientId
Size Int For folders this will be 0

 

Optional parameters Type Description
parentFolderId String Guid of the parent folder if you are creating a folder within a folder.
Otherwise it will be created at the root level

 

Example Request URL: https://<server domain name>/api/core/<version>/Folder/

BODY:

{
"entity": "Client",
"name": "APIfolder2018-07-22_23_55_40",
"isFolder": True,
"primaryDomainKey": "de67bc22-87c1-4c82-8668-4e386c4a58f0",
"size": 0
}
Example Response
{
"id": "64a4f970-1039-4889-aa34-6bf48cb815c8",
"name": "APIfolder2018-07-23_00_01_15",
"size": 0,
"isFolder": true,
"entity": "Client",
"primaryDomainKey": "de67bc22-87c1-4c82-8668-4e386c4a58f0"
}

Develop with us

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


Please leave this field empty.