# Mahnungen und Entwürfe suchen (https://developer.bimetrics.de/reference/receivables/list-reminders)

`GET https://app.bimetrics.de/api/reminder/`

operationId: `listReminders` · Berechtigung (Scope): `sales:read` · Bereich: Forderungen und Mahnungen

Liefert Mahnungsentwürfe, ausgestellte und zurückgezogene Mahnungen. status=all schließt den unveränderlichen Verlauf ein. Ein dokumentierter externer Versand ist kein Versandauftrag oder Zustellnachweis.

Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.

### Authentifizierung

`Authorization: Bearer bm_…` (alternativ `X-API-KEY: bm_…`, nie beide zugleich).

### Parameter

| Name | Ort | Pflicht | Typ | Beschreibung |
| --- | --- | --- | --- | --- |
| `limit` | query | nein | integer | Seitengröße; Standard 25, höchstens 100. |
| `offset` | query | nein | integer | Anzahl zu überspringender Treffer; Standard 0. |
| `search` | query | nein | string | Suche in Rechnungsnummer und Kundenname. |
| `status` | query | nein | string | Ein oder mehrere kommagetrennte Statuswerte draft, issued und withdrawn; all (Standard) enthält den vollständigen Verlauf. |
| `sort` | query | nein | string | Sortierfeld createdAt (Standard), number, customerName, sourceInvoiceNumber, issueDate, paymentDeadline oder status. |
| `direction` | query | nein | string | Sortierrichtung asc oder desc; Standard desc. Sortierung gilt vor der Seitenauswahl. |
| `sourceDraftId` | query | nein | string | Optionale UUID des Originalrechnungsentwurfs dieser Firma. Filtert vor Gesamtzahl und Seitenauswahl; mit status=draft lässt sich ein bestehender Mahnungsentwurf finden. |

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/reminder/" \
  -H "Authorization: Bearer $BIMETRICS_API_KEY"
```

### Antworten

| Status | Beschreibung | Inhalt |
| --- | --- | --- |
| 200 | Erfolg. | `application/json`: PaymentReminderPage |
| 400 | Ungültige Anfrage, z. B. ein Parameter mit ungültigem Wert wie eine ID, die keine UUID ist; korrigieren statt wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |
| 401 | Kein gültiger Schlüssel: fehlt (`Unauthorized`), ist unbekannt, abgelaufen oder widerrufen oder wurde nicht in genau einem Header gesendet (`InvalidAPIKey`). Schlüssel prüfen, nicht wiederholen. Auch eine ID, die zu einer anderen Firma gehört, ergibt `401 Unauthorized`. | `application/json`: Error |
| 403 | Dem Schlüssel fehlt die Berechtigung für diese Route (`APIKeyPermissionDenied`), oder die Firma hat keinen aktiven Tarif mit API-Zugang, etwa in der Testphase oder nach Ende des Abos (`APIUnavailable`). | `application/json`: Error |
| 413 | Die Anfrage ist zu groß (`APIRequestTooLarge`), siehe `x-bimetrics-limits`. | `application/json`: Error |
| 429 | Zu viele Anfragen; nach `Retry-After` Sekunden erneut senden. Mehr unter [Fehler](https://developer.bimetrics.de/errors). (Header: Retry-After) | `application/json`: Error |
| 500 | Serverfehler; die Anfrage später wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |

#### Felder der Antwort 200 (`PaymentReminderPage`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `items` | Array<PaymentReminder>, kann null sein | Mahnungen dieser Seite. |
| `total` | integer | Gesamtzahl aller Treffer. |

Verschachtelte Schemas stehen vollständig in der OpenAPI-Beschreibung: https://app.bimetrics.de/api/openapi.json