Course
venueNamestring · requiredcourseNamestring · required
venueIdstringcourseIdstringcountrystringstatestringcitystring
DraftScoresResult
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
scorecardarray
EntityResult
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
MatchplayDraftData
playerIdstring · requiredschoolIdstring · requiredmatchNuminteger · requiredteeGroupNuminteger · requiredresultstring · enum · requiredEnum values:WINLOSSTIEresultValuestring · required
dataSourcestringteamLabelstringmatchplayFormatstring · enumEnum values:SINGLESFOURSOMESFOURBALLisTotalsOnlybooleanplayerStatusstring · enumEnum values:PLAYEDWITHDRAWNDISQUALIFIEDDID_NOT_PLAYstrokesarraytotalStrokesinteger
PlayerRequest
playerNamestring · requiredplayerEmailstring · required
playerIdstringschoolIdstringdisplayNamestringIf displayName is not passed, playerName will be used as displayName
playerImagestringschoolYearstringplayerRankingStatusstring · enumSet this value based on the ranking status for the player
Enum values:ACTIVETURNED_PROINJUREDINACTIVE
Result
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
SearchResult
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
SetupResult
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
setuparraytournament setup response
StrokeDraftData
playerIdstring · requiredtotalStrokesinteger · required
dataSourcestringisTotalsOnlybooleanplayerStatusstring · enumEnum values:PLAYEDWITHDRAWNDISQUALIFIEDDID_NOT_PLAYCUTstrokesarray
TeamRequest
schoolNamestring · requiredboardNamestring · requiredgenderstring · enum · requiredEnum values:MenWomendivisionstring · requiredconferencestring · requiredregionstring · required
schoolIdstringcitystringstatestringzipstringschoolLogostringthumbnailstringheadCoachstringathleticDirectorstringassistantCoachstringteamColourstring
SimpleScoresResult
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
analyticsobject[]
Tee
teeGenderstring · requiredteeNamestring · requiredtotalYardsstring · requiredtotalParstring · required
teeIdstringholesstringyardsinteger[]parsinteger[]courseRatingnumber · float
TeeSetupData
roundIdinteger · required
courseLabelstring
venueIdstringcourseIdstringcourseNamestringteeNamestringteeIdstringholeNumberarrayparsarrayyardsarraytimesarraypinPositionXarraypinPositionYarraygreenDeptharraycourseRatingnumber · float
TeeTimesRequestData
teeGroupNuminteger · requiredschoolIdstring · requiredplayerIdstring · requiredteePlayerNuminteger · required
courseLabelstringteeTimestringstartingHoleintegermatchNumintegerphaseIdintegerphaseNamestringflightIdintegerflightNamestring
TeeTimesResponse
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
resultsarrayA list of search results
TeeTimesResponseData
teeGroupNuminteger · requiredplayersInfoobject[] · required
courseLabelstringeventTypestringteeTimestringstartingHoleintegermatchNuminteger
TournamentPlayersRequest
tournamentIdstring · requiredschoolIdstring · requiredteamLabelstring · enum · requiredEnum values:ABCDEWIND
playersListobject[]
TournamentPlayersResult
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
resultsobject[]A list of search results
TournamentRequest
tournamentNamestring · requiredgenderstring · enum · requiredEnum values:MenWomenCombined Men and Womendivisionstring · requiredeventTypestring · enum · requiredEnum values:Stroke PlayMatch PlayMedal Match PlaystartDatestring · date · requiredendDatestring · date · required
tournamentIdstringinviteTypestring · enumEnum values:teamindividualDefault: teamseasonintegerDefault: 2024teeStylestring · enumEnum values:Single TeeMultiple Tee"ShotgunDefault: Single TeetournamentLogostringmatchTypesstring[]Enum values:HEAD_TO_HEADBRACKETFLIGHTSNOT_SPECIFIEDfourpeopleTypesstring[]Enum values:SINGLESFOURBALLFOURSOMESvenuestringvenueIdstringcoursestringcitystringstatestringhostIdstringpermissedUsersstring[]numRoundsintegerDefault: 3numTeamPlayersintegerDefault: 5numTeamScoringintegerDefault: 4dataSourcestringroundsCompletedintegersponsorstringtournamentIntegrationIdstring · enumEnum values:golfstatgolfgeniusbirdiefiresmartgolfleaderboardkingscoreboardliveallowSubstituesbooleantournamentPrivacystring · enumEnum values:PUBLICPRIVATEtournamentLevelstring · enumEnum values:TOURNAMENTQUALIFYINGPRACTICE
TournamentTeamsResult
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
resultsobject[]A list of search results
Venue
venueNamestring · requiredName of the venue
citystring · requiredstatestring · required
venueIdstringUnique identifier of the venue
countrystringDefault: USA
Player
playerIdstringplayerNamestringschoolYearstringuserPicturestringdisplayNamestringteamTypestringrankinteger
schoolIdstring · requiredschoolNamestring · requiredgenderstring · enum · requiredEnum values:MenWomenCombined Men and Womendivisionstring · required
schoolLogostringschoolLogoThumbnailstringconferencestringregionstringboardNamestringcitystringstatestringzipstringheadCoachstringassistantCoachstringathleticDirectorstringrankinteger
PlayerUpdateRequest
playerNamestring · required
playerIdstringplayerEmailstringschoolIdstringPass new school_id to transfer the player to new team.
displayNamestringplayerImagestringschoolYearstringisInactivebooleanSet this value to true to remove the player from existing team-roster, by default this is false.
SchoolTeam
schoolIdstring · requiredschoolNamestring · requiredgenderstring · enum · requiredEnum values:MenWomenCombined Men and Womendivisionstring · required
schoolLogostringschoolLogoThumbnailstringconferencestringregionstringboardNamestringcitystringstatestringzipstringheadCoachstringassistantCoachstringathleticDirectorstringrankinteger
Tournament
tournamentIdstring · requiredUnique identifier of the tournament
tournamentNamestring · requiredName of the tournament
genderstring · enum · requiredEnum values:MenWomenCombined Men and Womendivisionstring · requiredeventTypestring · enum · requiredEnum values:Stroke PlayMatch PlayMedal Match PlaystartDatestring · requiredendDatestring · requireddataSourcestring · requiredinviteTypestring · enum · requiredEnum values:teamindividualhostIdstring · required
tournamentLogostringvenuestringcoursestringcitystringstatestringhostTypestring · enumEnum values:SCHOOLDIVISIONREGIONCONFERENCEhostNamestringhostBoardNamestringschoolLogostringschoolLogoThumbnailstringplannedRoundsintegerThe planned rounds of play entered by the host.
Default: 3numRoundsintegerRounds for which we have some data in the system.
Default: 3hasResultsbooleanisCompletebooleancompetingSchoolsstring[]sponsorstringtournamentPrivacystring · enumEnum values:PUBLICPRIVATEtournamentLevelstring · enumEnum values:TOURNAMENTQUALIFYINGPRACTICE
TournamentDetailsResult
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
resultsarray