GET /api/v1/attachment/{id}/ – Open Knowledge Foundation Germany Froide API

attachment

Changed on Sep 11, 2025

get/api/v1/attachment/{id}/

Request

The document declares no server URL.
Auth: one of:
- OAuth 2 (scopes: write:attachment)
- API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this Attachment.

Query parameters

format'csv' | 'json'

Response

resource_uristring uri required

idinteger required

belongs_tostring uri required

namestring required

filetypestring

sizeinteger nullable

site_urlstring required

anchor_urlstring required

file_urlstring required

pendingboolean

is_convertedboolean

convertedstring uri required

approvedboolean

can_approveboolean

can_change_approvalstring required

redactedstring uri required

is_redactedboolean

can_redactstring required

can_deletestring required

is_pdfstring required

is_imagestring required

is_irrelevantstring required

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)
Mar 3, 2025a3cbf0272cec Revision changes
- 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 (4 revisions)