Aller au contenu

API-documentatie

v1.0.0

Dossiers zoeken

GET /api/v1/cases

scope: cases:read 1 credits

Zoeken en filteren met dezelfde filters als de zoekpagina. Financiële en onderwerpfilters vereisen een abonnement met geavanceerd zoeken.

Queryparameters

Queryparameters
NaamTypeOmschrijving
sort

Sortering

enum | nullSortering relevance, declared_desc, declared_asc, name, estate_assets_desc, creditor_count_desc, distance, null
page

Paginanummer

integer | nullPaginanummer
per_page

Resultaten per pagina, maximaal 100

integer | nullResultaten per pagina, maximaal 100
q

Zoektekst

string | nullZoektekst
q_scope enum | null all, name, kvk, curator, location, null
status[] enum[] active, terminated, converted, transferred, annulled
procedure[] string[]
declared_from string | null
declared_to string | null
cir_publication_from string | null
cir_publication_to string | null
province[] enum Groningen, Fryslân, Drenthe, Overijssel, Flevoland, Gelderland, Utrecht, Noord-Holland, Zuid-Holland, Zeeland, Noord-Brabant, Limburg
city string | null
municipality string | null
postcode string | null
radius integer | null
bbox string | null
court[] string[]
curator[] string[]
law_firm[] string[]
legal_form[] string[]
sbi[] string[]
industry enum | null landbouw-bosbouw-en-visserij, delfstoffenwinning, industrie, energievoorziening, water-en-afvalbeheer, bouw, groot-en-detailhandel, vervoer-en-opslag, horeca, informatie-en-communicatie, financiele-dienstverlening, onroerend-goed, specialistische-zakelijke-diensten, overige-zakelijke-diensten, openbaar-bestuur, onderwijs, gezondheids-en-welzijnszorg, cultuur-sport-en-recreatie, overige-dienstverlening, huishoudens, extraterritoriale-organisaties, null
has_report boolean | null
topic[] string[]
estate_assets_min number | null
estate_assets_max number | null
concurrent_claims_min number | null
concurrent_claims_max number | null
creditor_count_min number | null
creditor_count_max number | null
employee_count_min number | null
employee_count_max number | null
conditions string | null

Antwoord, HTTP 200

Public data

Antwoord, HTTP 200

Antwoord, HTTP 200
NaamTypeOmschrijving
data verplicht object[]
data[].id verplicht string
data[].slug verplicht string
data[].name verplicht string
data[].status verplicht string
data[].procedure verplicht string
data[].insolvency_number verplicht string
data[].declared_on verplicht string
data[].last_cir_publication_on verplicht string | null
data[].terminated_on verplicht string | null
data[].legal_form verplicht string | null
data[].sbi_code verplicht string | null
data[].sbi_section verplicht string | null
data[].last_report_on verplicht string | null
data[].court verplicht object
data[].court.name verplicht string | null
data[].court.slug verplicht string | null
data[].location verplicht object
data[].location.city verplicht string | null
data[].location.municipality verplicht string | null
data[].location.province verplicht string | null
data[].location.lat verplicht number | null
data[].location.lng verplicht number | null
data[].curator verplicht object | null
data[].curator.name verplicht string
data[].curator.slug verplicht string | null
data[].figures verplicht object
data[].figures.estate_assets verplicht number | null
data[].figures.concurrent_claims verplicht number | null
data[].figures.creditor_count verplicht integer | null
data[].figures.employee_count verplicht integer | null
data[].report_count verplicht integer
data[].topics verplicht object[]
data[].topics[].topic verplicht string
data[].topics[].state verplicht string
data[].links verplicht object
data[].links.self verplicht string
data[].links.web verplicht string
meta verplicht object
meta.total verplicht integer
meta.page verplicht integer
meta.per_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