challenges

GET /api/v1/challenges/{id}

Changed on

Request

  • Base URL
    https://prices.openfoodfacts.org (the document declares no server; this is the origin it was published from)
  • URL
    https://prices.openfoodfacts.org/api/v1/challenges/{id}
  • Auth
    none declared

Path parameters

idinteger required

A unique integer value identifying this Challenge.

Response

idinteger required
status'DRAFT' | 'UPCOMING' | 'ONGOING' | 'COMPLETED' required
  • DRAFT - DRAFT
  • UPCOMING - UPCOMING
  • ONGOING - ONGOING
  • COMPLETED - COMPLETED
tagstring required
titlestring nullable
iconstring nullable
subtitlestring nullable
start_datestring date nullable
end_datestring date nullable
categoriesstring[]

Restrict to one or multiple categories (optional)

categories_fullstring[]

Full category tags with parents, used for matching & stats (readonly)

example_proof_urlstring nullable
promo_banner_image_urlstring nullable
promo_banner_urlstring nullable
promo_banner_alt_textstring nullable
is_publishedboolean
statsunknown
createdstring date-time
updatedstring date-time required

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status