Get started
API Reference
- Patient
- Contact
- Service
- Location
- Practitioner
- Appointment
- Support activity
- Support item
- Invoice
- Payment method
- Waitlist
- Screener
- Patient form
- Case
- Availability
- Payment
- Custom field
Appointment
Create a single appointment
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,
"caseId": 1,
"patientId": 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"
}'
{
"id": 1,
"start": "2023-07-30T09:00:00.000Z",
"end": "2023-07-30T09:00:00.000Z",
"isUnavailableBlock": false,
"serviceId": 1,
"locationId": 1,
"practitionerId": 1,
"maxPatients": 1,
"appointmentPatients": [
{
"appointmentId": 1,
"patientId": 1,
"caseId": 1,
"status": "Arrived",
"note": "Some notes",
"doNotInvoice": false,
"invoiceId": 1,
"cancellationReason": "Other",
"cancellationRate": 30,
"cancellationNote": "Some notes",
"statusUpdatedAt": "2023-07-30T09:00:00.000Z"
}
],
"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",
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z",
"deletedAt": "2023-07-30T09:00:00.000Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200 - application/json
Successfully created appointment
The response is of type object
.
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,
"caseId": 1,
"patientId": 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"
}'
{
"id": 1,
"start": "2023-07-30T09:00:00.000Z",
"end": "2023-07-30T09:00:00.000Z",
"isUnavailableBlock": false,
"serviceId": 1,
"locationId": 1,
"practitionerId": 1,
"maxPatients": 1,
"appointmentPatients": [
{
"appointmentId": 1,
"patientId": 1,
"caseId": 1,
"status": "Arrived",
"note": "Some notes",
"doNotInvoice": false,
"invoiceId": 1,
"cancellationReason": "Other",
"cancellationRate": 30,
"cancellationNote": "Some notes",
"statusUpdatedAt": "2023-07-30T09:00:00.000Z"
}
],
"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",
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z",
"deletedAt": "2023-07-30T09:00:00.000Z"
}
Assistant
Responses are generated using AI and may contain mistakes.