Dokumente auflisten

Dokumente werden nach ihrer Bereitstellung gelistet. Für den Abruf ist documents:read erforderlich; applications:read ist nicht zusätzlich nötig.

Beschreibung

Listet erzeugte und abrufbare Antragsdokumente.

Parameter

idpathPflicht

Öffentliche Antrags-ID.

Beispiel: app_test_1a2b3c4d5e6f708192a3b4c5

Responses

200

Liste der aktuell abrufbaren Dokumente; data kann leer sein.

401/403

API-Schlüssel oder Scope documents:read ist ungültig.

404

Antrag fehlt oder gehört zu einem anderen Mandanten beziehungsweise einer anderen Umgebung.

Response-Body

Content-Type: application/json. Die erfolgreiche Antwort enthält die nachfolgend beschriebenen Felder.

Response-Felder

Feld	Typ	Angabe	Beschreibung
`object`	string	Immer	Konstanter Wert `list`.
`data`	array	Immer	Abrufbare Dokumente des Antrags.
`data[].id`	string	Immer	Öffentliche Dokument-ID.
`data[].type`	string	Optional	Dokumentcode der Quelle.
`data[].name`	string	Immer	Anzeigebezeichnung.
`data[].filename`	string	Optional	Vorgeschlagener Dateiname.
`data[].mime_type`	string	Optional	MIME-Typ des Inhalts.
`data[].created_at`	date-time	Optional	Bereitstellungszeitpunkt.
`data[].download_url`	string	Immer	Authentifizierter Downloadpfad im öffentlichen API-Namensraum.

{
  "object": "list",
  "data": [
    {
      "id": "doc_17",
      "type": "TEST",
      "name": "api test result",
      "filename": "test-ergebnis-app_test_1a2b3c4d5e6f708192a3b4c5.pdf",
      "mime_type": "application/pdf",
      "created_at": "2026-08-23T10:48:51+02:00",
      "download_url": "/api/v1/applications/app_test_1a2b3c4d5e6f708192a3b4c5/documents/doc_17"
    }
  ]
}

Verfügbarkeit

Eine leere Liste ist bei einem laufenden Antrag normal. Dokumente werden erst gelistet, wenn ihr Inhalt vollständig bereitsteht. Der Endpunkt benötigt documents:read; eine zusätzliche Berechtigung applications:read ist nicht erforderlich.

Dokumenttypen

type enthält den Dokumentcode, sofern die Quelle einen Code liefert.
name ist die Anzeigebezeichnung. Für Programmlogik type verwenden.
download_url bleibt immer im öffentlichen Namensraum /api/v1/.

{ "object": "list", "data": [ { "id": "doc_17", "type": "TEST", "name": "api test result", "filename": "test-ergebnis-app_test_1a2b3c4d5e6f708192a3b4c5.pdf", "mime_type": "application/pdf", "created_at": "2026-08-23T10:48:51+02:00", "download_url": "/api/v1/applications/app_test_1a2b3c4d5e6f708192a3b4c5/documents/doc_17" } ] }