Naar de inhoud

API-documentatie

v1.0.0

Dossiers zoeken

GET/api/v1/cases

scope: cases:read1 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
modeenum | null lexical · semantic · null
page

Paginanummer

integer | nullPaginanummer
per_page

Resultaten per pagina, maximaal 100

integer | nullResultaten per pagina, maximaal 100
q

Zoektekst

string | nullZoektekst
q_scopeenum | null all · name · kvk · curator · location · null
status[]enum[] active · terminated · converted · annulled
procedure[]string[]
declared_fromstring | null
declared_tostring | null
cir_publication_fromstring | null
cir_publication_tostring | null
province[]enum Groningen · Fryslân · Drenthe · Overijssel · Flevoland · Gelderland · Utrecht · Noord-Holland · Zuid-Holland · Zeeland · Noord-Brabant · Limburg
citystring | null
municipalitystring | null
postcodestring | null
radiusinteger | null
bboxstring | null
court[]string[]
curator[]string[]
law_firm[]string[]
legal_form[]string[]
sbi[]string[]
industryenum | 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_reportboolean | null
topic[]string[]
estate_assets_minnumber | null
estate_assets_maxnumber | null
concurrent_claims_minnumber | null
concurrent_claims_maxnumber | null
creditor_count_minnumber | null
creditor_count_maxnumber | null
employee_count_minnumber | null
employee_count_maxnumber | null
conditionsstring | null

Antwoord · HTTP 200

Public data

Antwoord · HTTP 200

Antwoord · HTTP 200
NaamTypeOmschrijving
dataverplichtobject[]
data[].idverplichtstring
data[].slugverplichtstring
data[].nameverplichtstring
data[].statusverplichtstring
data[].procedureverplichtstring
data[].insolvency_numberverplichtstring
data[].declared_onverplichtstring
data[].last_cir_publication_onverplichtstring | null
data[].terminated_onverplichtstring | null
data[].legal_formverplichtstring | null
data[].sbi_codeverplichtstring | null
data[].sbi_sectionverplichtstring | null
data[].last_report_onverplichtstring | null
data[].courtverplichtobject
data[].court.nameverplichtstring | null
data[].court.slugverplichtstring | null
data[].locationverplichtobject
data[].location.cityverplichtstring | null
data[].location.municipalityverplichtstring | null
data[].location.provinceverplichtstring | null
data[].location.latverplichtnumber | null
data[].location.lngverplichtnumber | null
data[].curatorverplichtobject | null
data[].curator.nameverplichtstring
data[].curator.slugverplichtstring | null
data[].figuresverplichtobject
data[].figures.estate_assetsverplichtnumber | null
data[].figures.concurrent_claimsverplichtnumber | null
data[].figures.creditor_countverplichtinteger | null
data[].figures.employee_countverplichtinteger | null
data[].report_countverplichtinteger
data[].topicsverplichtobject[]
data[].topics[].topicverplichtstring
data[].topics[].stateverplichtstring
data[].linksverplichtobject
data[].links.selfverplichtstring
data[].links.webverplichtstring
metaverplichtobject
meta.totalverplichtinteger
meta.pageverplichtinteger
meta.per_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