Dokumentation

API-Referenz

GET/api/v1/applications

Anträge auflisten

Die Liste ist cursorbasiert und standardmäßig nach Erstellungszeit absteigend sortiert. Der API-Schlüssel begrenzt das Ergebnis auf Ihr Konto und seine Umgebung; erforderlich ist applications:read.

Beschreibung

Listet Ihre Anträge in der Schlüsselumgebung.

Parameter

limitquery

Seitengröße zwischen 1 und 25; Standardwert ist 20. Der Wert entspricht zugleich den Rate-Limit-Einheiten des Listenaufrufs.

Beispiel: 20
starting_afterquery

Öffentliche Antrags-ID aus next_cursor der vorherigen Antwort.

Beispiel: app_test_1a2b3c4d5e6f708192a3b4c5

Responses

200

Eine Seite von Antragsobjekten.

400

limit oder starting_after ist ungültig.

401/403

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

429

Rate Limit erreicht; Retry-After beachten.

Response-Body

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

Response-Felder

FeldTypAngabeBeschreibung
objectstringImmerKonstanter Wert list.
dataarrayImmerAntragsobjekte dieser Seite. Jedes Element entspricht dem Antrags-Response-Schema.
has_morebooleanImmerGibt an, ob eine weitere Seite vorhanden ist.
next_cursorstring|nullImmerCursor für starting_after; null am Listenende.
200 Response-Beispieljson
{
  "object": "list",
  "data": [
    {
      "id": "app_test_1a2b3c4d5e6f708192a3b4c5",
      "object": "vehicle_registration_application",
      "environment": "test",
      "livemode": false,
      "procedure": "new_registration",
      "procedure_code": "NZ",
      "submission_mode": "third_party",
      "holder": {
        "id": "hld_test_1a2b3c4d5e6f708192a3b4c5",
        "revision": 1,
        "verification_status": "verified"
      },
      "external_reference": "test-ci-1042",
      "status": "awaiting_signature",
      "status_details": {
        "label": "Freigabe ausstehend",
        "updated_at": "2026-08-23T10:42:18+02:00"
      },
      "next_action": {
        "type": "sign_application",
        "url": "/api/v1/test/signatures/0123456789abcdef0123456789abcdef0123456789abcdef"
      },
      "signature": {
        "required": true,
        "status": "pending",
        "url": "/api/v1/test/signatures/0123456789abcdef0123456789abcdef0123456789abcdef"
      },
      "results": {
        "decision": "pending"
      },
      "documents": [],
      "orders_url": "/api/v1/applications/app_test_1a2b3c4d5e6f708192a3b4c5/orders",
      "timestamps": {
        "created_at": "2026-08-23T10:42:18+02:00",
        "updated_at": "2026-08-23T10:42:18+02:00",
        "status_updated_at": "2026-08-23T10:42:18+02:00"
      }
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Cursor statt Seitennummer

Übergeben Sie next_cursor als nächsten starting_after-Wert. Der Cursor ist die öffentliche ID des letzten Elements der aktuellen Seite und dient nur der Pagination.

Der angeforderte limit-Wert entspricht den verbrauchten Rate-Limit-Einheiten: limit=20 kostet 20 Einheiten, limit=5 nur 5. Wählen Sie kleinere Seiten, wenn ein regelmäßiger Abgleich nicht die maximale Seitengröße benötigt.

Abgleich mit dem eigenen System

Nutzen Sie external_reference für Ihre Auftrags- oder Fahrzeugreferenz und die öffentliche id für alle weiteren API-Aufrufe. Interne numerische Datenbank-IDs werden nicht offengelegt. Der Endpunkt benötigt applications:read.

Zum Öffnen eines Treffers Enter drücken.