List leagues.
Returns leagues with their related data. Supports filtering, ordering and pagination. When download is true a CSV file is streamed 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 leagues whose name contains this value.
Genre IDs to filter by (comma-separated).
Subgenre IDs to filter by (comma-separated).
Owner user IDs to filter by (comma-separated).
Additional relationships to eager load (comma-separated).
Column to order by (e.g. name, genre_name, subgenre_name, owner_name, divisions_count, properties_count, scouting_priority, platforms_scouted, times_scouted_per_year, release_date).
Order direction (asc or desc).
When present, returns a paginated response instead of the full collection.
Items per page when paginated (default 25).
Page number when paginated.
When true, streams the result as a CSV file instead of returning JSON.
Response
A list of leagues (array, or paginated object when paginated is set). When download is true, a text/csv file is returned instead.
Changes
No recorded changes to this operation across all 2 revisions of this API.