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 Structure The response contains three top-level fields:

  • page - Pagination metadata (totalResults, currentPage, pageSize, totalPages, responseCount)
  • summary - Unfiltered aggregate stats across ALL your clients (not affected by filters)
  • clients - Paginated list of client objects matching your filters

Summary Stats (Unfiltered) The summary object always reflects your entire client portfolio, regardless of active filters:

  • totalClients - Total number of linked clients
  • attributedClients - Clients created through your integration (isAttributedClient=true)
  • onboardingComplete - Clients who have completed onboarding (signed agreements)
  • onboardingPending - Clients who have not yet completed onboarding
  • totalCases - Total debt collection cases across all clients

Per-Client 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)
  • isAttributedClient - Whether this client was created through your integration (true) or linked later (false)
  • dateLinked - When this client was linked to your platform (ISO 8601)
  • caseStats - Per-client case statistics: casesTotal, casesClosed, earningsUsd

Filtering Parameters

  • ExternalTenantId - Filter to specific client by your identifier
  • IsAttributedClient - Filter by attribution status (true = created by you, false = linked later)
  • OnboardingDone - Filter by onboarding completion (true = completed, false = pending)
  • 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: 10, min: 1, max: 100)
  • Response includes page metadata: total count, current page, page size, total pages

Sorting

  • Sort - Sort field and direction (format: 'field:direction')
  • Supported fields: dateCreated, name
  • Examples: 'dateCreated:desc', 'name:asc'
  • Default: dateCreated:desc (most recent first)

Use Cases

  • Build a client dashboard with portfolio-level KPIs (summary) and per-client details (clients)
  • Search for specific client by name, email, or registration number
  • Filter clients by onboarding status or attribution
  • Track per-client case volume and earnings
  • 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

  • IsAttributedClient=true - Client was created through the referral partner API. You earn revenue on ALL cases (100% of cases).
  • IsAttributedClient=false - Client existed in Debitura before the link was established (409 conflict scenario). You earn revenue ONLY on cases created through the referral partnership.

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