Payment groups

List Payment Groups

GET
/orgs/{organizationId}/payment-groups

Lists all payment groups with filtering, sorting, and pagination (including JSON path filters on metadata, e.g. ?metadata[externalKey]=...). Pass withStats (e.g. true, yes, bare ?withStats, or withStats=) to enrich each row with paymentCount, totalAmount, and totalAmountRemaining (when member refunds apply) aggregated across member payments (single member query, regardless of page size). Combine with include=invoice to also load the assigned invoice — both are how the PaymentGroupsTable and its row dropdown (assign when OPEN; sync eligible Mollie payments; delete when OPEN with no payments) consume this endpoint.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

Query Parameters

page?integer
Range-9007199254740991 <= value <= 9007199254740991
limit?integer
Range-9007199254740991 <= value <= 9007199254740991
sortBy?string
Value in"id""name""description""status""metadata""invoiceId""assignedAt""createdAt""updatedAt"
sortDir?string
Value in"asc""desc"
include?|array<>|string
invoiceId?string|array<string>|null
status?|array<>|
assignedAt?|null
createdAt?|null
updatedAt?|null
name?string|array<string>|
description?string|array<string>|
metadata?
hasPayments?boolean|string|number|null
hasNoPayments?boolean|string|number|null
hasEventLogs?boolean|string|number|null
hasNoEventLogs?boolean|string|number|null
hasAuditLogs?boolean|string|number|null
hasNoAuditLogs?boolean|string|number|null
paymentId?string|array<string>|
eventLogId?string|array<string>|
auditLogId?string|array<string>|
hasInvoice?boolean|string|number|null
hasNoInvoice?boolean|string|number|null
search?string
withStats?boolean|string|number|null

Response Body

Paginated payment groups; rows may include paymentCount, totalAmount, and totalAmountRemaining when withStats is enabled.

application/json
  1. response
curl -X GET 'https://api.tillor.eu/orgs/string/payment-groups'
null