Get Events

get

https://events.cortextech.io/v2/public/clients/{clientId}/events

Paginated list of events, filterable.
Sortable fields: homeTeam, awayTeam, date, competition, broadcaster, deadline, status, venue.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

Client identifier.

Query Params

startDate

date-time

Filter events on or after this date. RFC3339 timestamp.

endDate

date-time

Filter events on or before this date. RFC3339 timestamp.

startTime

string

Filter events starting at or AFTER this local time (HH:mm). Use with timezone.

endTime

string

Filter events starting at or BEFORE this local time (HH:mm). Use with timezone.

day

array of integers

Day of week (1=Sunday ... 7=Saturday).

day

round

array of strings

Filter by round(s).

round

teamId

array of strings

Filter by team ID (home or away).

teamId

homeTeamId

array of strings

Filter by home team ID(s).

homeTeamId

awayTeamId

array of strings

Filter by away team ID(s).

awayTeamId

venueId

array of strings

Filter by venue ID(s).

venueId

competitionId

array of strings

Filter by competition ID(s).

competitionId

excludeCompetitionId

array of strings

Exclude events belonging to these competition(s).

excludeCompetitionId

broadcasterId

array of strings

Filter by broadcaster ID(s).

broadcasterId

squadType

array of strings

Filter by competition squad type(s).

squadType

timezone

string

IANA timezone for time-of-day filters (default UTC).

eventId

array of strings

Filter to specific event ID(s).

eventId

status

array of strings

Filter by status value(s) - treated as case-insensitive regex patterns.

status

statusGroup

array of strings

Filter by status group(s).

statusGroup

teamNameSearch

string

Search events by team name.

sport

array of strings

Filter by sport(s).

sport

seasonId

string

Filter by season ID.

upcoming

date-time

Filter results by events starting (date) after the provided RFC3339 timestamp, including events.

date-time

Filter results by events starting (date) before provided RFC3339 timestamp, excluding postponed events.

createdDateFrom

date-time

Filter by creation date (from).

createdDateTo

date-time

Filter by creation date (to).

pageIndex

integer

≥ 0

Defaults to 0

Zero-based page index.

pageSize

integer

≥ 1

Defaults to 25

Number of items per page.

sortBy

string

Field name to sort by.

sortDirection

string

enum

Defaults to ASC

Sort direction.

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of events.

400Bad request.

500Internal server error.