Mergi la conținut

API-documentatie

v1.0.0

Veilingen

GET /api/v1/auctions

scope: auctions:read 1 credits

Veilingen uit faillissementen, met de koppeling aan het dossier en de herkomst.

Queryparameters

Queryparameters
NaamTypeOmschrijving
q

Zoektekst

string | nullZoektekst
closing enum | null today, 7d, 30d, null
category[] enum[] construction_machinery, vehicles, tools, stock, office_it, hospitality, real_estate, other
provider[] string[]
linked boolean | null
sector enum | null A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, null
curator string | null
postcode string | null
radius enum | null 10, 25, 50, 100, null
province enum | null Groningen, Fryslân, Drenthe, Overijssel, Flevoland, Gelderland, Utrecht, Noord-Holland, Zuid-Holland, Zeeland, Noord-Brabant, Limburg, null
sort

Sortering

enum | nullSortering closing, distance, newest, null
group enum | null case, null
page

Paginanummer

integer | nullPaginanummer

Antwoord, HTTP 200

Antwoord, HTTP 200

Antwoord, HTTP 200
NaamTypeOmschrijving
data verplicht mixed[]
meta verplicht object
meta.total verplicht integer
meta.page verplicht integer
meta.last_page verplicht integer

Antwoord, HTTP 422

Validation error

Antwoord, HTTP 422

Antwoord, HTTP 422
NaamTypeOmschrijving
error verplicht object
error.code verplicht

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message verplicht

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

De velden van het antwoord staan in openapi.json. Hoe elke waarde met bron is opgebouwd, leest u bij Gegevens en brondocumenten