The splose API follows a REST architectural style, offering JSON-encoded responses, standard HTTP response codes, easily understandable resource-oriented URLs, and robust authentication mechanisms.

​
Server

  • https://api.splose.com/v1
  • https://api-uk.splose.com/v1 (UK users)

​
Authentication

​
API Key Authentication

The splose API employs API keys for request authentication. Workspace owners can apply for and manage API keys through the splose dashboard. It’s crucial to safeguard the API key, as it grants the same permissions as the associated user.

​
Bearer Authentication

Authentication for API access is achieved via Bearer Authentication. Include the API key in the request header using the format: Authorization: Bearer your_api_key.

​
Secure Communication

All API requests must be conducted over HTTPS. Requests made over plain HTTP will not succeed. Additionally, unauthenticated API requests will result in failure.

​
Rate limit

There are limits to the number of API calls that your application can make with one API key.
  • Minute Limit: 60 calls per minute

​
Error

splose uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with splose’s servers. Error types:
  • 400 - Bad request: the request failed due to missing or invalid parameters.
  • 401 - Unauthorized: No valid API key provided.
  • 404 - Not Found: The requested resource doesn’t exist.
  • 429 - Too Many Requests: Too many requests hit the API too quickly.
  • 500 - Internal Server Error : Something went wrong on splose’s end.

​
Datetime

All datetime values provided in request parameters and responses are in Coordinated Universal Time (UTC). The accepted datetime formats are outlined below:
  • 2023-07-01
  • 2023-07-01T00:00:00Z
  • 2023-07-01T00:00:00.000Z

​
Pagination

​
Pagination for Multiple Objects

For endpoints returning multiple objects, pagination is in place to manage response sizes. Each response is limited to a certain number of objects. Additionally, the response includes a links field that provides URLs for fetching the next and/or previous pages, if applicable.

​
Manual Positioning

You have the option to manually specify the id_gt or id_lt value as a request parameter. This allows you to retrieve objects starting from a specific position. If neither of these values is provided, the initial page of objects will be returned by default.
  • id_gt: Request for next page of objects with id greater than the specified value.
  • id_lt: Request for previous page of objects with id less than the specified value.

​
Realtime feed

Certain users may require real-time data retrieval. Given the substantial data volume, retrieving the complete dataset may not be efficient. To address this, we offer the option to retrieve data based on its update timestamp. This approach necessitates fetching the entire dataset only during the initial request. Subsequent retrievals involve fetching solely the modified data to replace outdated information.
  • update_gt: Request for objects updated after the specified datetime.
  • update_lt: Request for objects updated before the specified datetime.

​
Changelog

  • 2025-06-20
    • add credit-note endpoint
  • 2025-05-12
    • Breaking change: move caseId into appointmentPatient field for appointment response
  • 2025-03-13:
    • add custom-filed endpoint
    • add endpoint to update patient
    • add endpoint to update custom field in patient
  • 2025-02-14:
    • add endpoint to create contact
    • add email field to practitioner response
  • 2025-01-31:
    • add endpoint to create patient
    • Add endpoint to create appoitment
  • 2024-12-13:
    • add endpoint to patient to upload file for patient
    • allow update more fields for appointment
  • 2024-11-27:
    • add name to contact response.
  • 2024-11-22:
    • add cancellationRate to appointment response.
  • 2024-09-30:
    • add contact endpoint.
    • add invoiceRecipientId to patient response.
  • 2024-09-03:
    • add PUT method to appointment and support-item endpoints.
    • add status_update_lt and status_update_gt parameter to appointment endpoint.
  • 2024-06-25:
    • add case, patient-form, screener and waitlist endpoints.
    • add customFields to patient response.
    • add statusUpdatedAt to appointment response.
  • 2024-04-29: add payment-method and payment endpoints.
  • 2024-02-28: add availability endpoint.