Gemeente Amsterdam Dossiers API

The dossiers API from Gemeente Amsterdam — 2 operation(s) for dossiers.

GitHub OpenAPI

Operations 2

GET /dossiers Bag dossiers list #
GET /dossiers/{dossier} Bag dossiers retrieve #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amsterdam-nl:amsterdam-nl-dossiers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amsterdam-nl-dossiers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amsterdam Nl Dossiers API
  version: 1.0.0
  contact:
    email: datapunt@amsterdam.nl
  license:
    name: ''
  termsOfService: https://data.amsterdam.nl/
  description: 'Operations tagged dossiers across 2 of this provider''s published API definitions: amsterdam-nl-bag-openapi-original.json, amsterdam-nl-bag-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.data.amsterdam.nl/
security:
- oauth2: []
tags:
- name: dossiers
paths:
  /dossiers:
    get:
      operationId: bag_dossiers_list
      description: In deze tabel staat geen data meer en wordt binnenkort verwijderd
      parameters:
      - in: header
        name: Accept-Crs
        schema:
          type: string
        description: Accept-Crs header for Geo queries
      - in: header
        name: Content-Crs
        schema:
          type: string
        description: Content-Crs header for Geo queries
      - in: header
        name: X-Api-Key
        schema:
          type: string
        description: Api Key for statistical purposes, not for authentication
      - name: _count
        required: false
        in: query
        description: Include a count of the total result set and the number of pages.Only works for responses that return a page.
        schema:
          type: boolean
      - in: query
        name: _csv_header
        schema:
          type: string
          enum:
          - id
          - title
          - none
        description: Specify type of header for csv file
      - in: query
        name: _csv_separator
        schema:
          type: string
          enum:
          - ','
          - ;
        description: Specify type of separator for csv file
      - in: query
        name: _expand
        schema:
          type: boolean
        description: Allow to expand relations.
      - in: query
        name: _expandScope
        schema:
          type: string
        description: Comma separated list of named relations to expand.
        examples:
          HeeftBrondocumenten:
            value: heeftBrondocumenten
            summary: heeftBrondocumenten
            description: De brondocument(en) behorende bij het dossier
          AllValues:
            value: heeftBrondocumenten
            summary: All Values
            description: Expand all fields, identical to only using _expand=true.
      - in: query
        name: _fields
        schema:
          type: string
        description: Comma-separated list of fields to display
      - in: query
        name: _format
        schema:
          type: string
          enum:
          - json
          - csv
          - geojson
        description: Select the export format
      - name: _pageSize
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: _sort
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: dossier
        in: query
        description: Verwijzing vanuit de overige objectklassen
        schema:
          type: string
      - name: dossier[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: dossier[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: dossier[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: dossier[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: dossier[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: heeftBrondocumenten.documentnummer
        in: query
        description: Exact; text
        schema:
          type: string
      - name: heeftBrondocumenten.documentnummer[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: heeftBrondocumenten.documentnummer[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: heeftBrondocumenten.documentnummer[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: heeftBrondocumenten.documentnummer[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: heeftBrondocumenten.documentnummer[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      tags:
      - dossiers
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PaginatedBagdossiersList'
            text/csv:
              schema:
                $ref: '#/components/schemas/PaginatedBagdossiersList'
            application/geo+json:
              schema:
                $ref: '#/components/schemas/PaginatedBagdossiersList'
          description: ''
      summary: Bag dossiers list
      x-summary-source: derived
    servers:
    - url: https://api.data.amsterdam.nl/
  /dossiers/{dossier}:
    get:
      operationId: bag_dossiers_retrieve
      parameters:
      - in: header
        name: Accept-Crs
        schema:
          type: string
        description: Accept-Crs header for Geo queries
      - in: header
        name: Content-Crs
        schema:
          type: string
        description: Content-Crs header for Geo queries
      - in: header
        name: X-Api-Key
        schema:
          type: string
        description: Api Key for statistical purposes, not for authentication
      - in: query
        name: _csv_header
        schema:
          type: string
          enum:
          - id
          - title
          - none
        description: Specify type of header for csv file
      - in: query
        name: _csv_separator
        schema:
          type: string
          enum:
          - ','
          - ;
        description: Specify type of separator for csv file
      - in: query
        name: _expand
        schema:
          type: boolean
        description: Allow to expand relations.
      - in: query
        name: _expandScope
        schema:
          type: string
        description: Comma separated list of named relations to expand.
        examples:
          HeeftBrondocumenten:
            value: heeftBrondocumenten
            summary: heeftBrondocumenten
            description: De brondocument(en) behorende bij het dossier
          AllValues:
            value: heeftBrondocumenten
            summary: All Values
            description: Expand all fields, identical to only using _expand=true.
      - in: query
        name: _fields
        schema:
          type: string
        description: Comma-separated list of fields to display
      - in: query
        name: _format
        schema:
          type: string
          enum:
          - json
          - csv
          - geojson
        description: Select the export format
      - name: _sort
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: path
        name: dossier
        schema:
          type: string
          title: Dossier ID
          description: Verwijzing vanuit de overige objectklassen
        required: true
      - name: dossier
        in: query
        description: Verwijzing vanuit de overige objectklassen
        schema:
          type: string
      - name: dossier[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: dossier[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: dossier[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: dossier[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: dossier[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: heeftBrondocumenten.documentnummer
        in: query
        description: Exact; text
        schema:
          type: string
      - name: heeftBrondocumenten.documentnummer[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: heeftBrondocumenten.documentnummer[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: heeftBrondocumenten.documentnummer[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: heeftBrondocumenten.documentnummer[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: heeftBrondocumenten.documentnummer[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      tags:
      - dossiers
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Bagdossiers'
            text/csv:
              schema:
                $ref: '#/components/schemas/Bagdossiers'
            application/geo+json:
              schema:
                $ref: '#/components/schemas/Bagdossiers'
          description: ''
      summary: Bag dossiers retrieve
      x-summary-source: derived
    servers:
    - url: https://api.data.amsterdam.nl/
components:
  schemas:
    BagdefaultDossiersLinks:
      type: object
      description: The contents of the `dossiers._links` field. It contains all relationships with objects.
      properties:
        schema:
          type: string
          format: uri
          description: The schema field is exposed with every record
          readOnly: true
        self:
          $ref: '#/components/schemas/BagdossiersLink'
        heeftBrondocumenten:
          type: array
          items:
            $ref: '#/components/schemas/BagdossiersHeeftBrondocumenten_M2M'
      required:
      - heeftBrondocumenten
      - schema
      - self
    PaginatedBagdossiersList:
      type: object
      properties:
        page:
          type: object
          properties:
            number:
              type: integer
              example: 3
            size:
              type: integer
              example: 20
            totalElements:
              type: integer
              example: 5
            totalPages:
              type: integer
              example: 3
        _links:
          type: object
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  format: uri
                  example: https://api.data.amsterdam.nl/v1/.../resource/?page=3
            next:
              type: object
              properties:
                href:
                  type:
                  - string
                  - 'null'
                  format: uri
                  example: https://api.data.amsterdam.nl/v1/.../resource/?page=4
            previous:
              type: object
              properties:
                href:
                  type:
                  - string
                  - 'null'
                  format: uri
                  example: https://api.data.amsterdam.nl/v1/.../resource/?page=2
        _embedded:
          type: object
          properties:
            dossiers:
              type: array
              items:
                $ref: '#/components/schemas/Bagdossiers'
    Bagdossiers:
      type: object
      description: In deze tabel staat  geen data meer en wordt binnenkort verwijderd
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/BagdefaultDossiersLinks'
          title: ' links'
        dossier:
          type: string
          title: Dossier ID
          description: Verwijzing vanuit de overige objectklassen
      required:
      - _links
      - dossier
    BagdossiersHeeftBrondocumenten_M2M:
      type: object
      description: The M2M table for `Dossiers.heeftBrondocumenten` that links to `Brondocumenten`
      properties:
        href:
          type: string
          format: uri
          readOnly: true
        documentnummer:
          type: string
          readOnly: true
        title:
          type: string
          readOnly: true
      required:
      - documentnummer
      - href
      - title
    BagdossiersLink:
      type: object
      description: The identifier of the relationship to dossiers.
      properties:
        href:
          type: string
          format: uri
          readOnly: true
        title:
          type: string
        dossier:
          type: string
          title: Dossier ID
          description: Verwijzing vanuit de overige objectklassen
      required:
      - dossier
      - href
      - title
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://iam.amsterdam.nl/auth/realms/datapunt-ad/protocol/openid-connect/auth
          scopes: {}
externalDocs:
  description: API Usage Documentation
  url: https://api.data.amsterdam.nl/v1/docs/datasets/bag.html
x-refined-from:
- amsterdam-nl-bag-openapi-original.json
- amsterdam-nl-bag-openapi.yml
x-versions:
  default:
    url: https://api.data.amsterdam.nl/v1/afvalwijzer
    status: stable
    endSupportDate: null
    statusDescription: stabiel
    default: true
    paths:
      afvalwijzer: stable
      acc_afvalwijzer: stable
    pathsUnderDevelopment: false
  v1:
    url: https://api.data.amsterdam.nl/v1/afvalwijzer/v1
    status: stable
    endSupportDate: null
    statusDescription: stabiel
    default: true
    paths:
      afvalwijzer: stable
      acc_afvalwijzer: stable
    pathsUnderDevelopment: false
    pathsDeprecated: false
    pathsDiscontinued: false