GET /api/v1/documentcollection/oembed/ – Open Knowledge Foundation Germany Froide API

documentcollection

Changed on Sep 11, 2025

get/api/v1/documentcollection/oembed/

Request

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

Query parameters

format'csv' | 'json'

Response

resource_uristring uri required

idinteger required

site_urlstring required

titlestring

descriptionstring

publicboolean required

listedboolean required

created_atstring date-time nullable required

updated_atstring date-time nullable required

document_countstring required

document_directory_countstring required

uidstring uuid required

cover_imagestring required

current_directorystring required

directoriesstring required

directory_stackstring required

documentsstring required

documents_uristring required

pages_uristring required

settingsunknown required

zip_download_urlstring required

Changes

Sep 11, 20252ba1a8b828b8 Revision changes
- 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
  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)
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)
- info
  api operation id oembedDocumentCollection removed and replaced with documentcollection_oembed_retrieve
- info
  the endpoint scheme security cookieAuth was added to the API
- info
  api tag documentcollection 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
  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)

Operation history