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
Request
- Base URLhttps://api.sponsorunited.com (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Filter by property name (partial match).
Column to order by.
Order direction.
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 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 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 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 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.
Page number.
Results per page (default 25).
When true, streams the full list as a CSV file instead of returning JSON.
Include a has_spend_tracker_data flag on each property.
Season id used when evaluating spend-tracker data.
Response
Paginated list of properties as JSON, or a CSV file stream when download=true.
Changes
No recorded changes to this operation across all 2 revisions of this API.