Skip to main content
Referral Partner API

Filter options

Referral Partners

Base URL
https://referral-api.debitura.com
Authentication
API key in the XApiKey header

Get available filter options for cases and earnings

GET/referral-partner/filter-options

Returns distinct filter options available for the authenticated referral partner's cases and earnings pages.

Countries — Distinct debtor countries from the referral partner's case history, sorted alphabetically.

CarveoutPartners — Collection partners from the referral partner's active JurisdictionPricingZone records (DateDeleted == null and DateDeactivated == null), sorted alphabetically.

Use the returned IDs as values for the CountryIds and CollectionPartnerIds query parameters on the cases and reporting/transactions endpoints.

Returns

200 Filter options retrieved successfully

  • countriesarray of objectsnullable

    Distinct debtor countries from the referral partner's case history, sorted by name.

  • carveoutPartnersarray of objectsnullable

    Collection partners from the referral partner's active JurisdictionPricingZone records, sorted by name.

Errors

500Internal server error

See Error handling.

GET/referral-partner/filter-options
curl https://referral-api.debitura.com/referral-partner/filter-options \
  -H "XApiKey: $DEBITURA_API_KEY"
Response
{
  "countries": [
    {
      "id": 3,
      "name": "Muster GmbH"
    }
  ],
  "carveoutPartners": [
    {
      "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
      "name": "Muster GmbH"
    }
  ]
}