GET /api/v1/document/ – Open Knowledge Foundation Germany Froide API

document

Changed on Sep 11, 2025

get/api/v1/document/

Request

The document declares no server URL.
Auth: API key in cookie sessionid

Query parameters

format'csv' | 'json'

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Response

countinteger required

nextstring uri nullable

previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

Sep 11, 20252ba1a8b828b8 Revision changes
- breaking
  the // response property's maxLength was unset from 250 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was unset from 250 for the response status (media type: text/csv)
- breaking
  the // response's property format changed from int64 to no format for status (media type: application/json)
- breaking
  the // response's property format changed from int64 to no format for status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response optional property // became read-only for the status (media type: application/json)
- info
  the response optional property // became read-only for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
Feb 17, 2025f5a1531aecbe Revision changes
- breaking
  the // response's property type changed from object to no type for status (media type: application/json)
- breaking
  the // response's property type changed from object to no type for status (media type: text/csv)
- breaking
  the // response's property type changed from object to no type for status (media type: application/json)
- breaking
  the // response's property type changed from object to no type for status (media type: text/csv)
- warning
  deleted the query request parameter collection
- warning
  deleted the query request parameter created_at
- warning
  deleted the query request parameter directory
- warning
  deleted the query request parameter foirequest
- warning
  deleted the query request parameter ids
- warning
  deleted the query request parameter portal
- warning
  deleted the query request parameter publicbody
- warning
  deleted the query request parameter tag
- info
  api operation id listDocuments removed and replaced with document_list
- info
  the endpoint scheme security cookieAuth was added to the API
- info
  api tag document added
- info
  api tag api removed
- info
  added the new optional query request parameter format
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  the response property // became required for the status (media type: application/json)
- info
  the response property // became required for the status (media type: text/csv)
- info
  added the required property // to the response with the status (media type: application/json)
- info
  added the required property // to the response with the status (media type: text/csv)
- info
  added the required property // to the response with the status (media type: application/json)
- info
  added the required property // to the response with the status (media type: text/csv)
- info
  added the required property // to the response with the status (media type: application/json)
- info
  added the required property // to the response with the status (media type: text/csv)
- info
  added the required property // to the response with the status (media type: application/json)
- info
  added the required property // to the response with the status (media type: text/csv)

Operation history