Skip to main content

List all linked clients

GET 
/clients

Retrieves a paginated list of all clients (creditors) linked to the authenticated referral partner.

Response Data For each client, the response includes: • ExternalTenantId - Your unique identifier for this client • OnboardingDone - Whether the client has completed onboarding (signed debt collection agreements) • OnboardingLinks - If onboarding incomplete, contains URL to complete the process • Client - Complete client information (ID, company name, registration number, country, address, contact details) • Users - List of all users associated with this client (ID, email, name)

Filtering Parameters • ExternalTenantId - Filter to specific client by your identifier • IsAttributedClient - Filter by attribution status (true = created by you, false = linked later) • DateCreatedFrom - Filter clients linked on or after this date (ISO 8601 format) • DateCreatedTo - Filter clients linked on or before this date (ISO 8601 format) • Query - Search across company name, email, and registration number (case-insensitive)

Pagination • Page - Page number (default: 1, min: 1) • PageSize - Results per page (default: 50, min: 1, max: 100) • Results are ordered by DateCreated descending (most recent first) • Response includes page metadata: total count, current page size, skip count

Use Cases • List all your clients for dashboard display • Search for specific client by name, email, or registration number • Filter clients by onboarding status • Identify clients created by you vs. existing clients you linked • Monitor client link creation dates • Paginate through large client lists

Client Attribution and Revenue Rules ⚠️ CRITICAL FOR REVENUE CALCULATIONS • IsAttributedClient=true - Client was created through the referral partner API

  • Referral partner earns revenue on ALL cases (100% of cases)
  • This is the default for clients created via POST /clients

• IsAttributedClient=false - Client existed in Debitura before the link was established (409 conflict scenario)

  • Referral partner earns revenue ONLY on cases created through the referral partnership
  • Cases created directly by the client (not through partner) do NOT generate referral revenue
  • This protects pre-existing client relationships

This distinction is the most important business rule for revenue calculations. Always check IsAttributedClient when forecasting or reconciling revenue.

Only active (non-archived) client links are returned.

Request​

Responses​

Clients retrieved successfully