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

pageannotation

Changed on Sep 11, 2025

get/api/v1/pageannotation/

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
- 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)
Feb 17, 2025f5a1531aecbe Revision changes
- breaking
  the // response's property format changed from binary to uri for status (media type: application/json)
- breaking
  the // response's property format changed from binary to uri for status (media type: text/csv)
- info
  api operation id listPageAnnotations removed and replaced with pageannotation_list
- info
  the endpoint scheme security cookieAuth was added to the API
- info
  api tag pageannotation 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)

Operation history