Welcome to GetBill API
The GetBill External API allows you to connect your existing systems to GetBill. The documentation covers the full API surface, but most client integrations only need a small set of endpoints to get started.Most integrations only need three steps
Start here if you want the standard client integration: authenticate, send debts to GetBill in batches, then receive updates when those debts change.1. Authenticate
Create an OAuth access token for secure API requests.
2. Import debts
Send debts in batches instead of creating them one by one.
3. Receive updates
Subscribe to
debt.status_changed to track collection progress.The rest of the documentation is available when you need more advanced workflows, reporting, followup data, or company-level information.
What you can do with the API
Beyond the typical integration path, the API can support more detailed workflows:Manage Debts
Manage Debts
Create, read, update, and delete debts in your system. Filter and search through your debt portfolio with advanced querying capabilities.
Track Followups
Track Followups
Monitor all followup activities including calls, emails, SMS, and WhatsApp communications. Get detailed insights into your collection efforts.
Generate Reports
Generate Reports
Access and download reports for your debt collection activities. Get comprehensive statistics and analytics for your business.
Webhook Integration
Webhook Integration
Set up webhooks to receive real-time notifications when events occur in your GetBill account.
Company Management
Company Management
Access company profile information, credit balance, user management, and comprehensive statistics.
Base URL
All API requests should be made to:API Versioning
The current API version isv1. The version is included in the URL path to ensure backward compatibility as we evolve the API.
Support
If you have any questions or need help with the API, please don’t hesitate to contact our support team:- Email: contact@getbill.io
- Documentation: docs.getbill.io
Rate Limits
The API is rate-limited to ensure fair usage and system stability. See the Rate Limits page for detailed information.