Operations related to the Players Scores for an event.
Unknown Golf (1.0)
Once you have set up your community in Unknown Golf, send an email to Support@UnknownGolf.com with a description of how you intend to utilize the Unknown Golf API.
We will review and may shedule a meeting to discuss further before providing your credentials.
Download OpenAPI description
Overview
API Support
License
Languages
Servers
Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/
Production
https://api.unknowngolf.com/v1/
Testing
https://api-test.unknowngolf.com/v1/
Community
Operations for Communities
What is a Community? A community in Unknown Golf is an entity that will group together all of your players and events.
What is a Club? A club is also a community, the main difference is that a club has sub communities and a club dashboard that provides insight into all of the Club's players and events.
Operations
Event
Operations related to the Events in your community (or Club)
Event Types: A tournament refers to a Multi-Round Event that has rounds (events) associated with it. These events have their event ids prefixed with the letter "M", a single round event or a round of a multi-round will have their event ids prefixed with the letter "S".
Creating an Event: Events can only be created on UnknownGolf.com, they currently cannot be created through the Unknwon Golf API.
Operations
Event Flights
Operations related to the Flights for an event.
Each leaderboard has its own set of flights which can be used for the following:
- Segment your leaderboards into groups by Handicap, Age, Course, etc....
- Determine if players or teams are participating in a Leaderboard. If a leaderboard has flights defined, a player or team is not assigned to a flight, then they are not participating in that leaderboard and will not show up in the standings or results for that leaderboard.
** Are Flights Required?** Single round events contain a setting to enable or disable flights, currently ALL multi-round events require flights, although this option is targeted to be added in the future.
Players: Players must be signed up for the event to be assigned to a flight.
Operations
Event Handicap (Player)
Operations related to Player Handicaps for an Event
Multi-Round Handicaps: For multi-round events, the player's will have handicaps set at the overall event level and then for each round which will override the event level for that round.
Course vs. Playing Handicap: The "Course Handicap" is the players calculated handicap for the assigned tee box (Slope, Rating, and Par).
The "Playing Handicap" is the player's course handicap and then applying allocations, an example allocation could be 80% of a player's handicap where their Course handicap is a 10 and their playing handicap is an 8.
Applying Allocations: Allocations are applied to the unrounded course handicap wich may result is 2 players having the same course handicap but slightly different playing handicaps.
Handicap Number of Holes: All handicaps consumed and calculated are for 18 holes, regardless of the number of holes that are being played. If you are manually setting a handicap for an event that is playing less then 18 holes, ensure you are setting an 18 hole equilivant handicap for the player.
Operations
Event Handicap (Team)
Operations related to Team Handicaps for an Event
Multi-Round Events: When setting a team handicap for a multi-round event, the handicap should be set for each round of the event, there is no option to set a team handicap for the entire event.
Course vs. Playing Handicap: The "Course Handicap" is the team's calculated handicap for their players.
The "Playing Handicap" is the team's course handicap and then applying allocations, an example allocation could be 50% of a team's total handicap, where their Course handicap is a 10 and their playing handicap is an 5.
Applying Allocations: Allocations are applied to the unrounded course handicap which may result is 2 teams having the same course handicap but slightly different playing handicaps.
Handicap Number of Holes: All handicaps consumed and calculated are for 18 holes, regardless of the number of holes that are being played. If you are manually setting a handicap for an event that is playing less than 18 holes, ensure you are setting an 18 hole equivalent handicap for the team.
Operations
Event Leaderboards
Operations related to the Leaderboards for an event.
A Leaderboard defines the format of play and payouts, and contains multiple different configurations per leaderboard type.
Multi-Round Events: For multi-round events, the set of leaderboards are created for each round of the event, in addition to the overall set of leaderboards.
Leaderboards set at the "round level" will define the format and payouts for just that round, where the leaderboards set at the "event level" will define the format and payouts for the entire event, inclusive of all rounds unless configured for a subset of rounds.
Add / Edit Leaderboard Configurations: Add and editing of leaderboards can only be done on UnknownGolf.com
List of Leaderboard types: Reference the Utility opertation "/util/leaderboards/types" for a full list of leaderboard types, additional information on the leaderboard types can be found in Unknown Golf's help documentation (help.UnknownGolf.com).
Operations
Event Players
Operations related to Players registering to participate in an Event
Player Types: Players registered for your Event can be registed by their Profile, or by their name and Gender.
Multi-Round Event vs. Single Round: For multi-round events, players are registered for the Multi-round, they are not registered individually for each round.
Note: Players registered by name will not have any communication method associated with them, and will not be able to be included in any reports other then this event.
Operations
Event Tee Pairings
Operations related to the Tee Pairings for an event.
Players: Players must be signed up for the event to be assigned to a tee pairing.
Course: Tee pairings are unique by golf course
Tee Group: The tee group is used to define the order of tee groups starting on the same hole at the same time. An examle is having an "A" and "B" group both starting on hole 1 at 8:00 AM. The "A" group would tee off first followed by the "B" group.
Operations
Player
Operations related to the Players in your community (or Club)
Security: You only have access to players that are in your community(s).
Player Updates: Once a player completes their profile on UnknownGolf.com, there are personal attributes that you cannot update, only the player themselves can make the updates on UnknownGolf.com
Duplicate Profiles & Merging Accounts: A unique profile is determined by a Unique Email Address or Unique World Handicap Id, if you receive an error message when adding (or updating) a player you will need to reach out to Support@UnknownGolf.com to have the profiles merged.
Operations
- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}?member=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Successful response
World Handicap Provider Id, reference the API for World Handicap Providers for the ids
Example: 3
Flag if updates to the player's personal information may be made through the Unknown Golf API
** Note: ** If the player has already completed their profile on UnknownGolf.com, updates to the player's personal information listed below can only be performed by the player on Unknown Golf:
- Name (First, Last, Suffix)
- Email Address
- World Handicap Id
- Date of Birth
- Phone Number
Only updates are restricted, if the player does not currently have an attribute set then setting that attribute is allowed. Example, if the player does not have a phone number set, you can set the phone number for them.
Example: true
Response
application/json
sample
{ "playerId": 1, "member": true, "firstName": "Bill", "lastName": "Trabosh", "suffix": "III", "gender": "M", "handle": "Founder", "email": "support@unknowngolf.com", "dob": "1988-07-14", "phoneCounryCode": "US", "phoneNumber": "5555555555", "hcActive": true, "hcProviderId": 3, "hcId": "55885", "hcIndex": 12.7, "hcRevisionDt": "2025-08-04" }
- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Bodyapplication/jsonrequired
Player search criteria
World Handicap Provider Id, reference the API for World Handicap Providers for the ids
Example: 3
- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players
- Production
https://api.unknowngolf.com/v1/v1/players
- Testing
https://api-test.unknowngolf.com/v1/v1/players
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"communityId": 19564,
"playerIds": [
4,
2445,
2434
],
"email": "support@unknowngolf.com",
"lastName": "Trab",
"member": true,
"hcProviderId": 3,
"hcId": "15.2"
}'Successful response
World Handicap Provider Id, reference the API for World Handicap Providers for the ids
Example: 3
Flag if updates to the player's personal information may be made through the Unknown Golf API
** Note: ** If the player has already completed their profile on UnknownGolf.com, updates to the player's personal information listed below can only be performed by the player on Unknown Golf:
- Name (First, Last, Suffix)
- Email Address
- World Handicap Id
- Date of Birth
- Phone Number
Only updates are restricted, if the player does not currently have an attribute set then setting that attribute is allowed. Example, if the player does not have a phone number set, you can set the phone number for them.
Example: true
Response
application/json
sample
[ { "playerId": 1, "member": true, "firstName": "Bill", "lastName": "Trabosh", "suffix": "III", "gender": "M", "handle": "Founder", "email": "support@unknowngolf.com", "dob": "1988-07-14", "phoneCounryCode": "US", "phoneNumber": "5555555555", "hcActive": true, "hcProviderId": 3, "hcId": "55885", "hcIndex": 12.7, "hcRevisionDt": "2025-08-04" } ]
Request
Create a player and add them to a community, if the player already exists in Unknown Golf then they will just be added to the community
Note: Players must be added to a community, you cannot create a player without adding them to at least one of your communities.
After the player is created, if you need to add them to additional communities you can via the "Player add to community" operation.
Security
bearerAuth
Player to create
World Handicap Provider Id, reference the API for World Handicap Providers for the ids
Example: 3
- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players
- Production
https://api.unknowngolf.com/v1/v1/players
- Testing
https://api-test.unknowngolf.com/v1/v1/players
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"communityId": 15254,
"member": true,
"firstName": "Bill",
"lastName": "Trabosh",
"suffix": "III",
"gender": "M / F",
"handle": "Founder",
"email": "support@unknowngolf.com",
"dob": "1987-01-26",
"phoneCountryCd": "US",
"phone": "5555555555",
"hcProviderId": 3,
"hcId": "6585452"
}'Successful response
World Handicap Provider Id, reference the API for World Handicap Providers for the ids
Example: 3
Flag if updates to the player's personal information may be made through the Unknown Golf API
** Note: ** If the player has already completed their profile on UnknownGolf.com, updates to the player's personal information listed below can only be performed by the player on Unknown Golf:
- Name (First, Last, Suffix)
- Email Address
- World Handicap Id
- Date of Birth
- Phone Number
Only updates are restricted, if the player does not currently have an attribute set then setting that attribute is allowed. Example, if the player does not have a phone number set, you can set the phone number for them.
Example: true
Response
application/json
sample
{ "playerId": 1, "member": true, "firstName": "Bill", "lastName": "Trabosh", "suffix": "III", "gender": "M", "handle": "Founder", "email": "support@unknowngolf.com", "dob": "1988-07-14", "phoneCounryCode": "US", "phoneNumber": "5555555555", "hcActive": true, "hcProviderId": 3, "hcId": "55885", "hcIndex": 12.7, "hcRevisionDt": "2025-08-04" }
- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/communities
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/communities
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Successful response
World Handicap Provider Id, reference the API for World Handicap Providers for the ids
Example: 3
Flag if updates to the player's personal information may be made through the Unknown Golf API
** Note: ** If the player has already completed their profile on UnknownGolf.com, updates to the player's personal information listed below can only be performed by the player on Unknown Golf:
- Name (First, Last, Suffix)
- Email Address
- World Handicap Id
- Date of Birth
- Phone Number
Only updates are restricted, if the player does not currently have an attribute set then setting that attribute is allowed. Example, if the player does not have a phone number set, you can set the phone number for them.
Example: true
Response
application/json
sample
[ { "id": 2, "name": "Unknown Golf Club", "club": true } ]
- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/email
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/email
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/email
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/email?email=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}/member
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}/member
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}/member
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}/member?member=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/dob
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/dob
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/dob
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/dob?dob=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/handicap
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/handicap
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/handicap
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/handicap?hcProviderId=0&hcId=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}/handle
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}/handle
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/communities/{communityId}/handle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/communities/{communityId}/handle?email=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/name
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/name
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/name
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/name?firstName=string&lasttName=string&suffix=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/phone
- Production
https://api.unknowngolf.com/v1/v1/players/{playerId}/phone
- Testing
https://api-test.unknowngolf.com/v1/v1/players/{playerId}/phone
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/players/{playerId}/phone?phoneCountryCd=string&phone=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/application.wadl/{path}
- Production
https://api.unknowngolf.com/v1/v1/application.wadl/{path}
- Testing
https://api-test.unknowngolf.com/v1/v1/application.wadl/{path}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-docs.unknowngolf.com/_mock/ug-api/v1/application.wadl/{path}'- Mock server
https://api-docs.unknowngolf.com/_mock/ug-api/v1/application.wadl
- Production
https://api.unknowngolf.com/v1/v1/application.wadl
- Testing
https://api-test.unknowngolf.com/v1/v1/application.wadl
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api-docs.unknowngolf.com/_mock/ug-api/v1/application.wadl