Property

List properties

Returns a paginated list of non-deleted properties. Supports filtering by name, league, genre, subgenre, division and market, plus ordering. When download=true, streams the list as a CSV file instead of JSON

get/api/team

Request

Query parameters

namestring

Filter by property name (partial match).

order_by'name' | 'parent' | 'league' | 'genre' | 'subgenre' | 'division' | 'market' | 'created_at'

Column to order by.

order'asc' | 'desc'

Order direction.

market_idstring
Example:[1,2,3]

Primary market ids to filter by. Accepts a JSON-encoded array ([1,2,3]), a single id (1), or market_id[]=1. An empty list is ignored.

league_idstring
Example:[1,2,3]

League ids to filter by. Accepts a JSON-encoded array ([1,2,3]), a single id (1), or league_id[]=1. An empty list is ignored.

division_idstring
Example:[1,2,3]

Division ids to filter by. Accepts a JSON-encoded array ([1,2,3]), a single id (1), or division_id[]=1. An empty list is ignored.

genre_idstring
Example:[1,2,3]

Genre ids to filter by. Accepts a JSON-encoded array ([1,2,3]), a single id (1), or genre_id[]=1. An empty list is ignored.

subgenre_idstring
Example:[1,2,3]

Subgenre ids to filter by. Accepts a JSON-encoded array ([1,2,3]), a single id (1), or subgenre_id[]=1. An empty list is ignored.

pageinteger

Page number.

per_pageinteger

Results per page (default 25).

downloadboolean

When true, streams the full list as a CSV file instead of returning JSON.

with_has_spend_tracker_databoolean

Include a has_spend_tracker_data flag on each property.

season_idinteger

Season id used when evaluating spend-tracker data.

Response

Paginated list of properties as JSON, or a CSV file stream when download=true.

current_pageinteger
per_pageinteger
totalinteger
last_pageinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.