Skip to main content
GET
List mandates
This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Abfrageparameter

archived
boolean

Filter by archived status of the mandate

debtor
string<uuid>

Filter by our ID of the debtor

debtor_organization_name
string

Filter by the name of the debtor's organization (in case debtor is an organization and has the 'organization' object associated with it)

debtor_person_first_name
string

Filter by the first name of the debtor (in case debtor is a person has the 'person' object associated with it). Can be combined with debtor_person_last_name

debtor_person_last_name
string

Filter by the last name of the debtor (in case debtor is a person and has the 'person' object associated with it). Can be combined with debtor_person_first_name

debtor_your_reference
string

Filter by the field your_reference of the mandate's debtor

Filter by the legal stage of the mandate

limit
integer

Anzahl der pro Seite zurückzugebenden Ergebnisse.

offset
integer

Der initiale Index, von dem die Ergebnisse zurückgegeben werden sollen.

payment_state
string

Filter by the payment state of the mandate

processing_state
string

Filter by the processing state of the mandate

reference_number
string

Filter by the reference number of the mandate

Antwort

200 - application/json
count
integer
erforderlich
Beispiel:

123

results
object[]
erforderlich
next
string<uri> | null
Beispiel:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null
Beispiel:

"http://api.example.org/accounts/?offset=200&limit=100"