Halter auflisten

Die Liste ist cursorbasiert und bleibt auf Ihr Konto sowie die Schlüsselumgebung begrenzt. Der Scope holders:read ist erforderlich.

Beschreibung

Listet Halter des authentifizierten Unternehmens und der Schlüsselumgebung.

Parameter

limitquery

Seitengröße zwischen 1 und 25; Standard 20.

Beispiel: 20

starting_afterquery

Cursor aus next_cursor.

Beispiel: hld_test_1a2b3c4d5e6f708192a3b4c5

Responses

200

Eine Seite von Halterobjekten.

400

Cursor oder Filter ist ungültig.

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	Halterobjekte dieser Seite. Jedes Element entspricht dem Halterschema.
`has_more`	boolean	Immer	Gibt an, ob eine weitere Seite vorhanden ist.
`next_cursor`	string\|null	Immer	Cursor für `starting_after`; `null` am Listenende.

{
  "object": "list",
  "data": [
    {
      "id": "hld_test_1a2b3c4d5e6f708192a3b4c5",
      "object": "holder",
      "environment": "test",
      "livemode": false,
      "external_reference": "customer-1842",
      "revision": 1,
      "verification_status": "unverified",
      "data": {
        "type": "person",
        "first_name": "Mara",
        "last_name": "Beispiel",
        "birth_date": "1988-04-12",
        "birth_place": "Bremen",
        "email": "mara.beispiel@example.com",
        "phone": "+491701234567",
        "address": {
          "street": "Am Markt",
          "house_number": "12",
          "postal_code": "28195",
          "city": "Bremen",
          "country_code": "DE"
        }
      },
      "created_at": "2026-08-26T10:15:00+02:00",
      "updated_at": "2026-08-26T10:15:00+02:00"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Mandanten- und Umgebungstrennung

Ein Schlüssel sieht ausschließlich die Halter Ihres Kontos und seiner Umgebung. Test- und Live-Halter werden niemals in derselben Liste gemischt.

{ "object": "list", "data": [ { "id": "hld_test_1a2b3c4d5e6f708192a3b4c5", "object": "holder", "environment": "test", "livemode": false, "external_reference": "customer-1842", "revision": 1, "verification_status": "unverified", "data": { "type": "person", "first_name": "Mara", "last_name": "Beispiel", "birth_date": "1988-04-12", "birth_place": "Bremen", "email": "mara.beispiel@example.com", "phone": "+491701234567", "address": { "street": "Am Markt", "house_number": "12", "postal_code": "28195", "city": "Bremen", "country_code": "DE" } }, "created_at": "2026-08-26T10:15:00+02:00", "updated_at": "2026-08-26T10:15:00+02:00" } ], "has_more": false, "next_cursor": null }