Get a Campaign

Use this endpoint to check dashboard configuration before submitting a snapshot.

Authentication

Requires debts:read or debts:write.

curl "https://getbill.io/external-api/v1/campaigns/client-a-2026" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

200

{
  "error": false,
  "message": "Success",
  "data": {
    "api_reference": "client-a-2026",
    "name": "Client A — 2026",
    "status": "active",
    "configured": true,
    "automated_enrichment": {
      "detect_civility": false,
      "validate_emails": false
    },
    "latest_snapshot": null,
    "created_at": "2026-01-05T09:00:00Z"
  }
}

The campaign is ready to try snapshot submission when configured is true and status is active. These values reflect setup completed in GetBill; the integration does not change them through this API. If submission returns campaign_mode_not_supported, ask a GetBill administrator to configure the campaign for snapshot synchronization. automated_enrichment is read-only information configured by the GetBill user. It is not accepted in provisioning or snapshot request bodies. Missing and cross-company references both return 404 campaign_not_found.

Get started

Guides

SFTP integration

Company API

Creditors API

Debtors API

Debts API

Timelines API

Campaigns API

Settings API

Invoice documents API

Followups API

Todos API

Status API

Authentication

​Authentication

Authentication