What Are API Client Keys?
API Client Keys allow developers and businesses to integrate Spur with their own systems, applications, or custom workflows. These keys provide programmatic access to your Spur workspace data and functionality.
Key Information
Workspace ID: Your unique workspace identifier (shown at the top of the API section)
Use this ID when making API calls to identify your specific Spur account
Example format: 6691
API Documentation: Three formats available for developers
Documentation here - Interactive Swagger UI at https://api.spurnow.com/docs
Open API YAML here - Machine-readable specification for development tools
Open API JSON here - Alternative format for different development environments
The Swagger documentation provides interactive testing where you can try API calls directly from your browser.
Creating API Client Keys
Step 1: Generate a New Key
Go to Settings → API
Click the blue "Create New API Client" button
Give your API key a descriptive name (e.g., "CRM Integration" or "Custom Dashboard")
Step 2: Secure Your Key
Copy the generated API key immediately after creation
Store it securely
The key format will be a long string like:
cf0b53070a2d38c6035edbc79b97b89ble3a178dbcde686f620ca...
Step 3: Test Your Integration
Use the API documentation to test your first calls
Verify the key works with simple requests before building complex integrations
Managing API Keys
Key List: All created API keys appear in the main section
Name: The label you gave each key
Actions: Copy or delete keys as needed
Key Actions:
Copy: Get the key to use in your applications
Delete: Remove keys that are no longer needed (permanent action)
Common Use Cases
Custom Integrations
Connect internal business systems to Spur
Build custom dashboards with conversation data
Create specialized reporting tools
Automation Workflows
Trigger Spur actions from external systems
Sync data between platforms in real-time
Create complex multi-step business processes
Data Analysis
Extract conversation data for analysis
Build custom analytics and reporting
Integration with business intelligence tools
Third-Party Applications
Connect apps that don't have direct Spur integration
Build middleware solutions for complex workflows
Create custom customer-facing applications
Security Best Practices
Key Management
Create separate keys for different integrations
Use descriptive names to track what each key is for
Regularly audit and remove unused keys
Access Control
Only share keys with authorized developers/systems
Store keys securely (environment variables, secure vaults)
Never expose keys in client-side code or public repositories
Monitoring
Monitor API usage for unusual activity
Set up alerts for high-volume or failed requests
Review integration logs regularly
API Capabilities
With API access, you can:
Read Data: Access conversations, contacts, and analytics
Send Messages: Trigger automated responses and notifications
Manage Contacts: Create, update, and organize customer information
Control Flows: Start and stop automation sequences
Custom Fields: Read and write custom contact attributes
Frequently Asked Questions
Q: Are there rate limits on API usage? A: Yes, check the API documentation for current limits. Limits vary by plan level.
Q: Can I regenerate a lost API key?
A: No, you'll need to create a new key and update your integrations.
Q: What happens if I delete an API key that's in use?
A: All systems using that key will immediately lose access. Update integrations before deleting keys.
Q: Can multiple systems use the same API key?
A: Yes, but it's better to create separate keys for easier management and security.
Q: Is there a limit to how many API keys I can create?
A: Check your plan limits, but most accounts can create multiple keys.
Q: Can API keys access all workspace data?
A: Keys have the same permissions as the account that created them. Review documentation for specific endpoint permissions.
Getting Started with Development
Step 1: Review Documentation
Read through the API documentation linked in the interface
Understand authentication requirements and endpoint structure
Review example requests and responses
Step 2: Set Up Development Environment
Configure your development tools with the API key
Set up proper error handling for API calls
Implement secure key storage practices
Step 3: Start Simple
Begin with read-only operations (getting contact lists, conversation data)
Test authentication and basic connectivity
Gradually add more complex functionality
Step 4: Production Deployment
Use separate API keys for development and production
Implement proper logging and monitoring
Set up backup systems and error recovery
Troubleshooting
Issue: Authentication failed
Solution: Verify the API key is correct and hasn't been deleted
Check that you're using the right workspace ID
Issue: Rate limit exceeded
Solution: Implement request throttling, review your usage patterns
Consider upgrading your plan for higher limits
Issue: API calls returning errors
Solution: Check the API documentation for proper request format
Verify required parameters and data types
Issue: Integration suddenly stopped working
Solution: Check if the API key was deleted or if there are service issues
Support and Resources
For technical support with API integration:
Review the complete API documentation first
Check example code and use cases
Contact Spur support for integration assistance
Consider consulting with a developer if you're not technical
API access requires technical knowledge - consider working with a developer for complex integrations