API Reference
This is a comprehensive reference for all COMPASS API endpoints. Each endpoint includes detailed information about parameters, responses, and usage examples.Base URL
Authentication
All API requests (except OAuth endpoints) require authentication using a JWT token:Endpoint Categories
Authentication
OAuth integration and session management for secure API access.
View Authentication Details →
User Management
Complete user lifecycle management including profiles, permissions, and department assignments.
View User Management →
Departments
Organizational structure management with hierarchical support and user assignments.
View Department Management →
Email Meter
Advanced email analytics and performance metrics for transportation operations.
View Email Analytics →
HubSpot Tickets
Customer support ticket management with advanced filtering and export capabilities.
View Ticket Management →
Permissions
System-wide permission management for role-based access control.
View Permissions →
Transcription
Audio-to-text conversion services with confidence scoring and management.
View Transcription →
Response Format
Success Response
All successful responses follow this format:Error Response
Error responses use this format:HTTP Status Codes
Common Parameters
Date Parameters
Most endpoints use ISO 8601 date format:Pagination Parameters
List endpoints support pagination:Query Parameters
Filter and search parameters:Rate Limiting
API endpoints are rate-limited to ensure fair usage:
Rate limit headers are included in responses:
SDK Examples
JavaScript/Node.js
Python
Testing
Using curl
Using Postman
-
Import Environment Variables:
-
Set Authorization Header:
-
Test Endpoints:
- GET
{{base_url}}/users/profile - GET
{{base_url}}/departments/list - GET
{{base_url}}/email-meter/stats/email-counts/2025-10-01/2025-10-20
- GET
Best Practices
Security
- Always use HTTPS in production
- Store JWT tokens securely
- Implement token refresh logic
- Validate all input data
Performance
- Use appropriate pagination
- Cache static data when possible
- Implement retry logic for failed requests
- Monitor API usage and optimize
Error Handling
- Always check HTTP status codes
- Handle rate limit responses gracefully
- Implement exponential backoff for retries
- Log errors for debugging
Changelog
Version 1.0.0
- Initial API release
- OAuth authentication with Google and Microsoft
- Complete user management system
- Department hierarchy management
- Email analytics and reporting
- HubSpot ticket integration
- Permission system
- Audio transcription services
Support
- Documentation: This comprehensive guide
- Status Page: Check system status
- Support Email: support@example.com
- GitHub Issues: Report bugs and feature requests