Competition

List competitions

Changed on

List competitions (archive), with optional name/state filters and pagination.

get/v1/competitions

Request

Query parameters

namestring

Optional case-insensitive substring match on competition name.

statestring

Optional state filter: pre | live | ended. Empty returns all states.

limitinteger

Max rows to return. Defaults to 100 when 0, capped at 500.

offsetinteger

Number of matching rows to skip.

sort_bystring

Optional sort column: created_at | updated_at | name. Empty defaults to start_time descending (the historical ordering).

sort_orderstring

Optional sort direction: asc | desc. Empty defaults to desc. Ignored when sort_by is empty.

Response

A successful response.

totalinteger

Total competitions matching the filter, ignoring pagination.

Changes