Absender
Endpunkte zum Auflisten, Erstellen und Löschen von Absendern. Ein Absender steht für die Firma oder Person auf eingehenden Rechnungen, Verträgen und Briefen.
https://api.paperarchive.io/v1/senderssenders:readAlle Absender auflisten, die in den für deinen API-Schlüssel zugänglichen Spaces verfügbar sind: Absender, die einem Space zugeordnet sind, und Absender von Dokumenten in diesem Space. Absender werden automatisch per KI aus Dokumenten erkannt oder können manuell zugewiesen werden.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
space_id | uuid | optional | Nur Absender, die in diesem Space verfügbar sind. |
Code examples
curl -X GET "https://api.paperarchive.io/v1/senders" \
-H "Authorization: Bearer pa_live_abc123def456" https://api.paperarchive.io/v1/senderssenders:writeEinen neuen Absender in einem Space erstellen. Absender-Namen sind pro Nutzer eindeutig, unabhängig von Groß- und Kleinschreibung: Hast du schon einen Absender mit diesem Namen, wird er mit Status 200 statt 201 zurückgegeben und ist danach auch im angegebenen Space verfügbar. Hast du einen ähnlichen Absender (andere Schreibweise oder Rechtsform, bekannter Alias, ähnlicher Name, z. B. "ACME GmbH" zu "Acme"), schlägt die Anfrage mit Status 409 fehl: {"success": false, "error": "similar_exists", "candidates": [{"id", "name", "match_kind", "score"}]}. Nutze einen der Kandidaten oder sende die Anfrage mit "force": true erneut, um den Absender trotzdem anzulegen.
Request body
| Name | Type | Required | Description |
|---|---|---|---|
name | string | required | Absendername. |
space_id | uuid | required | Space, in dem der Absender erstellt werden soll. |
force | boolean | optional | Absender auch anlegen, wenn ähnliche existieren (überspringt die 409-Prüfung similar_exists). Standard: false. |
Code examples
curl -X POST "https://api.paperarchive.io/v1/senders" \
-H "Authorization: Bearer pa_live_abc123def456" \
-H "Content-Type: application/json" \
-d '{"name": "Acme Corp", "space_id": "space-uuid-1"}' https://api.paperarchive.io/v1/senders/:idsenders:writeEinen Absender löschen. Funktioniert nur für Absender in Spaces, die für deinen API-Schlüssel zugänglich sind.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | uuid | required | Die zu löschende Absender-ID. |
Code examples
curl -X DELETE "https://api.paperarchive.io/v1/senders/sender-uuid-1" \
-H "Authorization: Bearer pa_live_abc123def456"