QonektoInstall

Summary

List contracts (Vertraege) from the Qonekto API by sending a GET request to the /vertrag endpoint.

Inputs

• Optional Kunde Filter — Filter results by customer ID (Ameise Kundennummer). Can be provided as a numeric ID or by searching for a customer (uses the customer's ID). Sent as query parameter 'kunde_id'.
• Optional Search — Search for contracts where the insurance policy number (versicherungsscheinnummer) or risk (risiko) begins with the provided keyword. Sent as query parameter 'search'.
• Pagination Fields — Control pagination of results. 'Per Page' (default 50, max 100) sets the number of results per page. 'Page' (default 1) returns the specified page number; requires 'Per Page' to be set to enable pagination. Sent as query parameters 'per_page' and 'page'.

Output shape

Array of contract objects (Vertraege) matching the filters and pagination settings.

Each object represents a contract and includes fields such as versicherungsscheinnummer, risiko, beitrag_netto, beginn, ablauf, and associated customer and policy details. The exact structure depends on the API response.

Examples

Example 1: List all contracts for a specific customer by ID

Set Optional Kunde Filter → kunde_id to '12345'.

Example 2: Search for contracts starting with policy number 'ABC' and paginate results

Set Optional Search → search to 'ABC'. Set Pagination Fields → Per Page to 25 and Page to 2.