Challenges

Challenges_list

GET
/api/v1/challenges

Query Parameters

end_date__gt?string
Formatdate
end_date__gte?string
Formatdate
end_date__lt?string
Formatdate
end_date__lte?string
Formatdate
end_date__month?number
end_date__year?number
id?integer
is_published?boolean
order_by?string

Which field to use when ordering the results.

page?integer

A page number within the paginated result set.

size?integer

Number of results to return per page.

start_date__gt?string
Formatdate
start_date__gte?string
Formatdate
start_date__lt?string
Formatdate
start_date__lte?string
Formatdate
start_date__month?number
start_date__year?number
status?string
  • DRAFT - DRAFT
  • UPCOMING - UPCOMING
  • ONGOING - ONGOING
  • COMPLETED - COMPLETED
Value in"COMPLETED" | "DRAFT" | "ONGOING" | "UPCOMING"

Response Body

curl -X GET "https://loading/api/v1/challenges?end_date__gt=2019-08-24&end_date__gte=2019-08-24&end_date__lt=2019-08-24&end_date__lte=2019-08-24&end_date__month=0&end_date__year=0&id=0&is_published=true&order_by=string&page=0&size=0&start_date__gt=2019-08-24&start_date__gte=2019-08-24&start_date__lt=2019-08-24&start_date__lte=2019-08-24&start_date__month=0&start_date__year=0&status=COMPLETED"
{
  "items": [
    {
      "id": 0,
      "locations": [
        {
          "id": 0,
          "osm_brand_logo_url": "string",
          "type": "OSM",
          "osm_id": 9223372036854776000,
          "osm_type": "NODE",
          "osm_name": "string",
          "osm_display_name": "string",
          "osm_tag_key": "string",
          "osm_tag_value": "string",
          "osm_brand": "string",
          "osm_address_postcode": "string",
          "osm_address_city": "string",
          "osm_address_country": "string",
          "osm_address_country_code": "string",
          "osm_lat": -9999,
          "osm_lon": -9999,
          "osm_version": 2147483647,
          "website_url": "http://example.com",
          "price_count": 2147483647,
          "user_count": 2147483647,
          "product_count": 2147483647,
          "proof_count": 2147483647,
          "source": "string",
          "created": "2019-08-24T14:15:22Z",
          "updated": "2019-08-24T14:15:22Z"
        }
      ],
      "status": "DRAFT",
      "tag": "string",
      "title": "string",
      "icon": "string",
      "subtitle": "string",
      "start_date": "2019-08-24",
      "end_date": "2019-08-24",
      "categories": [
        "string"
      ],
      "categories_full": [
        "string"
      ],
      "example_proof_url": "string",
      "is_published": true,
      "stats": null,
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "page": 1,
  "pages": 16,
  "size": 100,
  "total": 1531
}