​
Integrate through the API

The JSON API is the preferred path for real-time and highly automated integrations. API integrations use one of two patterns. Choose based on whether your system sends debts as they become due or can provide the complete active receivables portfolio for a campaign. If this concept is new to you, start with Understand Campaigns to distinguish a campaign, timeline, import, and snapshot.

​
Pattern 1: Event-driven debt import

Use the standard three-step integration to send debts as they become due and receive collection updates as they happen.

1. Authenticate

Create an OAuth access token for secure API requests.

2. Import debts

Send debts individually or in batches as they become due.

3. Receive updates

Subscribe to debt.status_changed to track collection progress.

​
Pattern 2: Complete campaign synchronization

Use this pattern when your system can send the complete active receivables portfolio for one campaign on a regular basis.

1. Configure the campaign

Assign a stable campaign reference, then configure its collection timeline in the GetBill dashboard.

2. Submit a complete snapshot

Send every active receivable for that campaign in one request or in staged chunks for larger portfolios.

3. Follow processing

Poll the status URL until processing completes, then submit the next regular snapshot.
A campaign snapshot tells GetBill: “this is the complete current portfolio for this campaign.” When processing completes, any active debt not included is recorded as paid outside GetBill. Only use this workflow with a complete source extract.
Campaign synchronization uses stable campaign and snapshot references, supports one-request snapshots up to 20,000 rows or staged uploads up to 100,000 rows, and is processed asynchronously. It accepts either one balance per invoice or one global balance per debtor/account. See Synchronize Campaign Snapshots for balance granularity, setup, idempotency, and recovery rules. The general Campaign Snapshots API accepts complete full_sync campaigns only. The dedicated SFTP bridge can also synchronize status_sync campaigns, where omitted debts remain unchanged. For automatically managed SFTP cohorts, monthly campaigns use the mode configured on the bridge. Once a campaign exists for a bridge and month, its mode is not changed automatically. A conflicting bridge setting blocks the run instead of changing reconciliation behavior silently.

​
What you can do with the API

Beyond the typical integration path, the API can support more detailed workflows:
Create, read, update, and delete debts in your system. Filter and search through your debt portfolio with advanced querying capabilities.
Monitor all followup activities including calls, emails, SMS, and WhatsApp communications. Get detailed insights into your collection efforts.
Access and download reports for your debt collection activities. Get comprehensive statistics and analytics for your business.
Set up webhooks to receive real-time notifications when events occur in your GetBill account.
Access company profile information, credit balance, user management, and comprehensive statistics.

​
API fundamentals

The current API version is v1. Include it in the base URL for every request:
The version in the URL path preserves backward compatibility as the API evolves.

Authenticate

Learn how to obtain and use OAuth access tokens.

Review rate limits

Understand the limits that protect API stability and fair usage.

Check API status

Monitor service health and ongoing incidents.

Download Postman collection

Import every public API request, then enter your OAuth Client Credentials.

​
Next steps

If you are starting a new API integration, configure OAuth and then make your first API call.