API Docs / Operations / Clients / List Third-Party Mappings

List Third-Party Mappings

GET /tenants/{tenant}/clients/third-party-mappings

Returns a paged list of clients with their accounting, direct debit and AML mapping identifiers. Use the 'unmapped' query parameter to filter to clients missing a specific mapping (values: accounting, directdebit, aml).

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

unmapped query string
offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by.

Name

Field to sort by.

Name

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

Responses

401 Unauthorized – Invalid or missing API key