The Kickscale API allows you to retrieve and upload conversation data from your workspace.
You can query Meetings and Calls by date, customer domain, or unique ID.
You can also upload Calls directly into Kickscale for analysis.
API Basics
The Kickscale API is available at:
Base URL: https://api.kickscale.com
Swagger Documentation: https://api.kickscale.com/swagger
We recommend starting with the Swagger documentation.
It shows all available endpoints, parameters, and example requests.
Authentication
Every API request must include authentication headers.
Without these headers, requests will fail.
Required HTTP Headers
Each request must include:
api-key– Your personal API keyclient-id– Your Kickscale Client ID
You can find both of these values in the Settings -> Integrations -> API & Webhooks Section within the Kickscale Platform.
Keep these credentials secure.
Do not share them publicly or commit them to source control.
Manage API Keys
You can create and delete your API Keys in the Kickscale Platform if you have either the "Configurator" or "Admin" roles. You can find the Settings in Settings -> Integrations -> API & Webhooks
Here you can also find your Client ID that is required by the API.
API Keys are valid for one year.
The API Key is only shown once, so make sure to copy it immediately after creating it.
You can create as much API Keys as you need, but we recommend using only one
Available API Capabilities
Query Meetings
You can retrieve Meetings stored in Kickscale.
Supported filters include:
Date range
Customer domain
Meeting ID
Query Calls
You can retrieve Calls using the same filtering options.
Supported filters include:
Date range
Customer domain
Call ID
Upload Calls
You can upload Calls directly into Kickscale using the API.
This is helpful when:
Calls are recorded outside supported integrations
Historical Calls need to be imported
Custom telephony systems are used
Uploaded Calls become part of Kickscale analysis and Insights.
Using the Swagger Documentation
The Swagger interface is the best place to explore the API.
It allows you to:
See all available endpoints
Understand required parameters
Test requests directly in your browser
Tips & Best Practices
Start with read-only requests to validate authentication.
Use small date ranges when testing queries.
Handle API errors gracefully in your integration.
Avoid hardcoding credentials in production code.
Troubleshooting
Authentication errors
Check that both api-key and client-id headers are included and correct.
Unexpected responses
Verify parameters and formats using the Swagger documentation.
Missing data
Confirm that Meetings or Calls exist for the selected date or domain.
If endpoint behavior is unclear, check the Swagger Documentation.