Search
Search across main categories in the system
path Parameters
categorystring · enum · requiredCategory to perform the search against
Enum values:teamsplayerstournamentsvenuecoursetee
query Parameters
querystringThe search term to look for
divisionstring · enumFilter for the division
Enum values:NCAA Division INCAA Division IINCAA Division IIINAIANJCAA INJCAA IINCCAAUSCAAmultiMatchQuerystringThe search term to look on tournamentName or hostName, applicable for only tournaments search
fromStartDatestringFilter by the beginning start date
toStartDatestringFilter by the ending start date
fromEndDatestringFilter by the beginning end date
toEndDatestringFilter by the ending end date
hostSchoolNameMatchstringThe search term to look for in host school name
hostBoardNameMatchstringThe search term to look for in host board name
genderstring · enumFilter for the gender
Enum values:MenWomenCombined Men and WomenconferencestringFilter for the conference
schoolIdstringFilter for the school applicable for users and schedules passed as comma seperated values
playerIdstringFilter for the player
filterstring · enumFilter for searching tournaments only
Enum values:rangeglobalyearstringFilter for tournaments only, Year of the event in "YYYY" format (2023)
monthstringFilter for tournaments only, Month of the event in "mm" format (01)
sortFieldstringOrder by this field rather than rank
sortOrderstring · enumSorting order provided to return date schedules by recency
Enum values:ASCDESCvenueIdstringFor course search only. Find all courses at a venue
greaterThanRoundsintegerFor tournaments only. Find all tournaments with intended rounds greater than this value.
tournamentLevelstring · enumFor tournaments only.
Enum values:TOURNAMENTQUALIFYINGPRACTICEtournamentPrivacystring · enumFor tournaments only. Search tournaments based on the privacy.
Enum values:PUBLICPRIVATElimitintegerNumber of items to return
offsetintegerOffset for pagination
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
ok response
resultstring · enum · requiredThe outcome of the function invoked
Enum values:successfailed
messagestringA simple message to describe the outcome of the function
messageTypestring · enumEnum values:TOURNAMENTTEAMPLAYERTOURNAMENT_DETAILSTEAM_ROSTERCOURSE_DETAILSTEE_GROUPSTOURNAMENT_PLAYERS
sizeintegertotal count of objects in the database
resultsarrayA list of search results
Get Team
Get an existing school team
path Parameters
schoolIdstring · required
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
ok response
resultstring · enum · requiredThe outcome of the function invoked
Enum values:successfailed
messagestringA simple message to describe the outcome of the function
messageTypestring · enumEnum values:TOURNAMENTTEAMPLAYERTOURNAMENT_DETAILSTEAM_ROSTERCOURSE_DETAILSTEE_GROUPSTOURNAMENT_PLAYERS
sizeintegertotal count of objects in the database
resultsarrayA list of search results
Get Player Roster
Get the roster of players for the school
path Parameters
schoolIdstring · required
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
ok response
resultstring · enum · requiredThe outcome of the function invoked
Enum values:successfailed
messagestringA simple message to describe the outcome of the function
messageTypestring · enumEnum values:TOURNAMENTTEAMPLAYERTOURNAMENT_DETAILSTEAM_ROSTERCOURSE_DETAILSTEE_GROUPSTOURNAMENT_PLAYERS
sizeintegertotal count of objects in the database
resultsarrayA list of search results
Get Player Details
Get an existing player in the school
path Parameters
playerIdstring · required
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
ok response
resultstring · enum · requiredThe outcome of the function invoked
Enum values:successfailed
messagestringA simple message to describe the outcome of the function
messageTypestring · enumEnum values:TOURNAMENTTEAMPLAYERTOURNAMENT_DETAILSTEAM_ROSTERCOURSE_DETAILSTEE_GROUPSTOURNAMENT_PLAYERS
entity