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

campaign

Changed on Feb 17, 2025

get/api/v1/campaign/

Request

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

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

Feb 17, 2025f5a1531aecbe Revision changes
- info
  api operation id listCampaigns removed and replaced with campaign_list
- info
  the endpoint scheme security cookieAuth was added to the API
- info
  api tag campaign 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's property pattern ^(?:[a-z0-9.+-]*)://(?:[^\s:@/]+(?::[^\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z¡-0-9](?:[a-z¡-0-9-]{0,61}[a-z¡-0-9])?(?:\.(?!-)[a-z¡-0-9-]{1,63}(?<!-))*\.(?!-)(?:[a-z¡--]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\s]*)?\z was removed for the status (media type: application/json)
- info
  the // response's property pattern ^(?:[a-z0-9.+-]*)://(?:[^\s:@/]+(?::[^\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z¡-0-9](?:[a-z¡-0-9-]{0,61}[a-z¡-0-9])?(?:\.(?!-)[a-z¡-0-9-]{1,63}(?<!-))*\.(?!-)(?:[a-z¡--]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\s]*)?\z was removed for the status (media type: text/csv)

Operation history