Skip to main content
GET
Search status updates across mandates

Authorizations

Authorization
string
header
required

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

Query Parameters

created_after
string<date-time>

Include updates whose effective status timestamp is on or after this ISO 8601 timestamp.

created_before
string<date-time>

Include updates whose effective status timestamp is on or before this ISO 8601 timestamp.

Filter by the legal stage stored on the update.

Available options:
ended,
extrajudicial,
foreclosure,
judicial_dunning,
long_term_monitoring
limit
integer

Anzahl der pro Seite zurückzugebenden Ergebnisse.

mandate
string<uuid>

Filter by the publishing mandate ID.

offset
integer

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

processing_state
enum<string>

Filter by the processing state stored on the update.

Available options:
canceled_by_client,
canceled_by_service_provider,
ended,
in_progress,
paused
q
string

Case-insensitive substring search in title and HTML-free description, or an exact case-insensitive event code. The search term must contain at least 3 characters.

reference_number
string

Filter by a current or historical case reference number.

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

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

previous
string<uri> | null
Example:

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