Naar de inhoud

API-documentatie

v1.0.0

Veilingen

GET/api/v1/auctions

scope: auctions:read1 credits

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

Queryparameters

Queryparameters
NaamTypeOmschrijving
q

Zoektekst

string | nullZoektekst
closingenum | null today · 7d · 30d · null
category[]enum[] construction_machinery · vehicles · tools · stock · office_it · hospitality · real_estate · other
provider[]string[]
linkedboolean | null
sectorenum | null A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · null
curatorstring | null
postcodestring | null
radiusenum | null 10 · 25 · 50 · 100 · null
sort

Sortering

enum | nullSortering closing · distance · newest · null
page

Paginanummer

integer | nullPaginanummer

Antwoord · HTTP 200

Antwoord · HTTP 200

Antwoord · HTTP 200
NaamTypeOmschrijving
dataverplichtmixed[]
metaverplichtobject
meta.totalverplichtinteger
meta.pageverplichtinteger
meta.last_pageverplichtinteger

Antwoord · HTTP 422

Validation error

Antwoord · HTTP 422

Antwoord · HTTP 422
NaamTypeOmschrijving
errorverplichtobject
error.codeverplicht

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.messageverplicht

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