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

Request

The document declares no server URL.
Auth: one of:
- API key in cookie sessionid
- none

Query parameters

ancestorstring

depthinteger

format'csv' | 'json'

is_topicboolean

limitinteger

Number of results to return per page.

namestring

offsetinteger

The initial index from which to return the results.

parentstring

qstring

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

Feb 17, 2025f5a1531aecbe Revision changes
- breaking
  for the query request parameter depth, the type changed from string to integer
- breaking
  for the query request parameter is_topic, the type changed from string to boolean
- info
  api operation id listCategories removed and replaced with category_list
- info
  the endpoint scheme security cookieAuth was added to the API
- info
  api tag category 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's property pattern was changed from ^[-\w]+\z to ^[-\w]+$ for the status (media type: application/json)
- info
  the // response's property pattern was changed from ^[-\w]+\z to ^[-\w]+$ for the status (media type: text/csv)

Operation history