The splose API lets account owners connect their splose account to external systems. For example, retrieving data, managing payments, and updating appointments or support items. Access is granted on request, and your API key is managed from your account settings.
This guide covers how to request API access, find your API key, and manage your API settings.
Before you begin
API access is available to the account owner only.
Contact the splose Support Team to request access. Include your intended start date and planned use cases (for example, integrating with a third-party tool like Zapier, or data extraction).
Wait for approval before continuing. The API Keys tab appears only after your request is approved and the page is refreshed.
Find and manage your API key
The steps below outline how to locate your API key and settings.
Click your profile icon in the top-right corner of splose.
Select My Account.
Open the API (or API/keys) tab.
View your API key and manage your API settings from this tab.
Things to Note
Store your API key securely to prevent unauthorised access.
splose does not keep a copy of your API key. If you lose it, you'll need to generate a new one.
Implementing integrations requires programming knowledge. Refer to the API documentation for endpoints, authentication methods, and usage guidelines.
The splose API supports retrieving data (GET), adding payments (POST), retrieving payments (GET), deleting payments (DELETE), and updating appointments or support items (PUT).
FAQs and Troubleshooting
I can't see the API tab in My Account.
I can't see the API tab in My Account.
The API Keys tab only appears after your access request is approved. Once approved, refresh the page and it will show under My Account.
I've lost my API key. Can splose resend it?
I've lost my API key. Can splose resend it?
No. splose doesn't retain a copy of your key, so you'll need to generate a new one. Contact splose support if you're having trouble accessing the API section.
Who can request API access?
Who can request API access?
The account owner. Contact the splose Support Team with your start date and intended use cases.
