Create a single appointment

curl --request POST \
  --url https://api.splose.com/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": "2023-07-30T09:00:00.000Z",
  "end": "2023-07-30T09:00:00.000Z",
  "serviceId": 1,
  "locationId": 1,
  "practitionerId": 1,
  "patientId": 1,
  "caseId": 1,
  "note": "Some notes",
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z",
  "deletedAt": "2023-07-30T09:00:00.000Z"
}
'

import requests

url = "https://api.splose.com/v1/appointments"

payload = {
    "start": "2023-07-30T09:00:00.000Z",
    "end": "2023-07-30T09:00:00.000Z",
    "serviceId": 1,
    "locationId": 1,
    "practitionerId": 1,
    "patientId": 1,
    "caseId": 1,
    "note": "Some notes",
    "createdAt": "2023-07-30T09:00:00.000Z",
    "updatedAt": "2023-07-30T09:00:00.000Z",
    "deletedAt": "2023-07-30T09:00:00.000Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start: '2023-07-30T09:00:00.000Z',
    end: '2023-07-30T09:00:00.000Z',
    serviceId: 1,
    locationId: 1,
    practitionerId: 1,
    patientId: 1,
    caseId: 1,
    note: 'Some notes',
    createdAt: '2023-07-30T09:00:00.000Z',
    updatedAt: '2023-07-30T09:00:00.000Z',
    deletedAt: '2023-07-30T09:00:00.000Z'
  })
};

fetch('https://api.splose.com/v1/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start' => '2023-07-30T09:00:00.000Z',
    'end' => '2023-07-30T09:00:00.000Z',
    'serviceId' => 1,
    'locationId' => 1,
    'practitionerId' => 1,
    'patientId' => 1,
    'caseId' => 1,
    'note' => 'Some notes',
    'createdAt' => '2023-07-30T09:00:00.000Z',
    'updatedAt' => '2023-07-30T09:00:00.000Z',
    'deletedAt' => '2023-07-30T09:00:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/appointments"

	payload := strings.NewReader("{\n  \"start\": \"2023-07-30T09:00:00.000Z\",\n  \"end\": \"2023-07-30T09:00:00.000Z\",\n  \"serviceId\": 1,\n  \"locationId\": 1,\n  \"practitionerId\": 1,\n  \"patientId\": 1,\n  \"caseId\": 1,\n  \"note\": \"Some notes\",\n  \"createdAt\": \"2023-07-30T09:00:00.000Z\",\n  \"updatedAt\": \"2023-07-30T09:00:00.000Z\",\n  \"deletedAt\": \"2023-07-30T09:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.splose.com/v1/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start\": \"2023-07-30T09:00:00.000Z\",\n  \"end\": \"2023-07-30T09:00:00.000Z\",\n  \"serviceId\": 1,\n  \"locationId\": 1,\n  \"practitionerId\": 1,\n  \"patientId\": 1,\n  \"caseId\": 1,\n  \"note\": \"Some notes\",\n  \"createdAt\": \"2023-07-30T09:00:00.000Z\",\n  \"updatedAt\": \"2023-07-30T09:00:00.000Z\",\n  \"deletedAt\": \"2023-07-30T09:00:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/appointments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start\": \"2023-07-30T09:00:00.000Z\",\n  \"end\": \"2023-07-30T09:00:00.000Z\",\n  \"serviceId\": 1,\n  \"locationId\": 1,\n  \"practitionerId\": 1,\n  \"patientId\": 1,\n  \"caseId\": 1,\n  \"note\": \"Some notes\",\n  \"createdAt\": \"2023-07-30T09:00:00.000Z\",\n  \"updatedAt\": \"2023-07-30T09:00:00.000Z\",\n  \"deletedAt\": \"2023-07-30T09:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "start": "2023-07-30T09:00:00.000Z",
  "end": "2023-07-30T09:00:00.000Z",
  "serviceId": 1,
  "locationId": 1,
  "practitionerId": 1,
  "maxPatients": 1,
  "appointmentPatients": [
    {
      "appointmentId": 1,
      "patientId": 1,
      "caseId": 1,
      "status": null,
      "note": "Some notes",
      "invoiceId": 1,
      "cancellationReason": "Other",
      "cancellationRate": 30,
      "cancellationNote": "Some notes",
      "statusUpdatedAt": "2023-07-30T09:00:00.000Z",
      "doNotInvoice": false
    }
  ],
  "repeatId": "12345678-abcd-4321-dcba-12a34b56c78d",
  "recurringRule": "DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6",
  "unit": "Hour",
  "pricing": 193.99,
  "total": 193.99,
  "taxType": "STANDARD",
  "supportItemIds": [
    1
  ],
  "note": "Some notes",
  "deletedAt": "2023-07-30T09:00:00.000Z",
  "isUnavailableBlock": false,
  "busyTimePractitionerIds": [],
  "archived": false,
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}

Create a single appointment

curl --request POST \
  --url https://api.splose.com/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": "2023-07-30T09:00:00.000Z",
  "end": "2023-07-30T09:00:00.000Z",
  "serviceId": 1,
  "locationId": 1,
  "practitionerId": 1,
  "patientId": 1,
  "caseId": 1,
  "note": "Some notes",
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z",
  "deletedAt": "2023-07-30T09:00:00.000Z"
}
'

import requests

url = "https://api.splose.com/v1/appointments"

payload = {
    "start": "2023-07-30T09:00:00.000Z",
    "end": "2023-07-30T09:00:00.000Z",
    "serviceId": 1,
    "locationId": 1,
    "practitionerId": 1,
    "patientId": 1,
    "caseId": 1,
    "note": "Some notes",
    "createdAt": "2023-07-30T09:00:00.000Z",
    "updatedAt": "2023-07-30T09:00:00.000Z",
    "deletedAt": "2023-07-30T09:00:00.000Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start: '2023-07-30T09:00:00.000Z',
    end: '2023-07-30T09:00:00.000Z',
    serviceId: 1,
    locationId: 1,
    practitionerId: 1,
    patientId: 1,
    caseId: 1,
    note: 'Some notes',
    createdAt: '2023-07-30T09:00:00.000Z',
    updatedAt: '2023-07-30T09:00:00.000Z',
    deletedAt: '2023-07-30T09:00:00.000Z'
  })
};

fetch('https://api.splose.com/v1/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start' => '2023-07-30T09:00:00.000Z',
    'end' => '2023-07-30T09:00:00.000Z',
    'serviceId' => 1,
    'locationId' => 1,
    'practitionerId' => 1,
    'patientId' => 1,
    'caseId' => 1,
    'note' => 'Some notes',
    'createdAt' => '2023-07-30T09:00:00.000Z',
    'updatedAt' => '2023-07-30T09:00:00.000Z',
    'deletedAt' => '2023-07-30T09:00:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/appointments"

	payload := strings.NewReader("{\n  \"start\": \"2023-07-30T09:00:00.000Z\",\n  \"end\": \"2023-07-30T09:00:00.000Z\",\n  \"serviceId\": 1,\n  \"locationId\": 1,\n  \"practitionerId\": 1,\n  \"patientId\": 1,\n  \"caseId\": 1,\n  \"note\": \"Some notes\",\n  \"createdAt\": \"2023-07-30T09:00:00.000Z\",\n  \"updatedAt\": \"2023-07-30T09:00:00.000Z\",\n  \"deletedAt\": \"2023-07-30T09:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.splose.com/v1/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start\": \"2023-07-30T09:00:00.000Z\",\n  \"end\": \"2023-07-30T09:00:00.000Z\",\n  \"serviceId\": 1,\n  \"locationId\": 1,\n  \"practitionerId\": 1,\n  \"patientId\": 1,\n  \"caseId\": 1,\n  \"note\": \"Some notes\",\n  \"createdAt\": \"2023-07-30T09:00:00.000Z\",\n  \"updatedAt\": \"2023-07-30T09:00:00.000Z\",\n  \"deletedAt\": \"2023-07-30T09:00:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/appointments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start\": \"2023-07-30T09:00:00.000Z\",\n  \"end\": \"2023-07-30T09:00:00.000Z\",\n  \"serviceId\": 1,\n  \"locationId\": 1,\n  \"practitionerId\": 1,\n  \"patientId\": 1,\n  \"caseId\": 1,\n  \"note\": \"Some notes\",\n  \"createdAt\": \"2023-07-30T09:00:00.000Z\",\n  \"updatedAt\": \"2023-07-30T09:00:00.000Z\",\n  \"deletedAt\": \"2023-07-30T09:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "start": "2023-07-30T09:00:00.000Z",
  "end": "2023-07-30T09:00:00.000Z",
  "serviceId": 1,
  "locationId": 1,
  "practitionerId": 1,
  "maxPatients": 1,
  "appointmentPatients": [
    {
      "appointmentId": 1,
      "patientId": 1,
      "caseId": 1,
      "status": null,
      "note": "Some notes",
      "invoiceId": 1,
      "cancellationReason": "Other",
      "cancellationRate": 30,
      "cancellationNote": "Some notes",
      "statusUpdatedAt": "2023-07-30T09:00:00.000Z",
      "doNotInvoice": false
    }
  ],
  "repeatId": "12345678-abcd-4321-dcba-12a34b56c78d",
  "recurringRule": "DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6",
  "unit": "Hour",
  "pricing": 193.99,
  "total": 193.99,
  "taxType": "STANDARD",
  "supportItemIds": [
    1
  ],
  "note": "Some notes",
  "deletedAt": "2023-07-30T09:00:00.000Z",
  "isUnavailableBlock": false,
  "busyTimePractitionerIds": [],
  "archived": false,
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

start

required

Appointment start date time

Example:

"2023-07-30T09:00:00.000Z"

end

required

Appointment end date time

Example:

"2023-07-30T09:00:00.000Z"

serviceId

integer

required

The service id of this appointment

Required range: x > 0

Example:

1

locationId

integer

required

The location id of this appointment

Required range: x > 0

Example:

1

practitionerId

integer

required

The practitioner id of this appointment

Required range: x > 0

Example:

1

patientId

integer

required

The patient id of this appointment

Required range: x > 0

Example:

1

caseId

integer

The case id of this appointment

Required range: x > 0

Example:

1

note

string

The appointment note

Example:

"Some notes"

createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

deletedAt

Object archived date time

Example:

"2023-07-30T09:00:00.000Z"

Response

200 - application/json

Successfully created appointment

integer

required

Appointment id

Required range: x > 0

Example:

1

start

required

Appointment start date time

Example:

"2023-07-30T09:00:00.000Z"

end

required

Appointment end date time

Example:

"2023-07-30T09:00:00.000Z"

serviceId

integer | null

required

The service id of this appointment

Required range: x > 0

Example:

1

locationId

integer

required

The location id of this appointment

Required range: x > 0

Example:

1

practitionerId

integer | null

required

The practitioner id of this appointment

Required range: x > 0

Example:

1

maxPatients

integer

default:1

required

The max patient number of this appointment. A number greater than 1 indicates a group appointment.

Required range: x > 0

appointmentPatients

object[]

required

The status of each patient of this appointment

Show child attributes

repeatId

string | null

required

An recurring appointment will have this repeat id

Example:

"12345678-abcd-4321-dcba-12a34b56c78d"

recurringRule

string | null

required

The rule for recurring appointment

Example:

"DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6"

unit

enum<string> | null

default:Hour

required

The appointment unit

Available options:

Hour,

Each

pricing

number | null

required

The appointment unit price, in dollar

Example:

193.99

total

number | null

required

The appointment total price without tax, in dollar

Example:

193.99

taxType

required

Tax type, check Splose support for more info

Available options:

STANDARD,

ZERO,

EXEMPT,

REDUCED

Example:

"STANDARD"

supportItemIds

integer[]

required

Array of support item ids of this appointment

Required range: x > 0

Example:

[1]

note

string | null

required

The appointment note

Example:

"Some notes"

deletedAt

required

Object archived date time

Example:

"2023-07-30T09:00:00.000Z"

isUnavailableBlock

boolean | null

default:false

deprecated

@deprecated - please refer to the new busy-time endpoint. Whether this time slot is unavailable, eg. busy time or meeting

busyTimePractitionerIds

integer[]

deprecated

@deprecated - please refer to the new busy-time endpoint. The practitioner ids of this multiple practitioners busy time

Required range: x > 0

archived

boolean | null

default:false

Whether the appointment has been archived

createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

Get started

API Reference

Create a single appointment

Authorizations

Body

Response