Clubessential

Getting Started

Introduction

Customizing API Endpoints

Blank

BlueGolf API

Production

Sandbox

<p class="slate-p " >Welcome to the <strong class="slate-bold">BlueGolf Partner API</strong>!</p><p class="slate-p " >This API provides access to a wide range of endpoints that allow you to access and integrate BlueGolf’s data and services into your applications, enabling efficient management of membership, tournaments, and participation information. It’s designed for flexibility, scalability, and ease of integration.</p><p class="slate-p " >The <strong class="slate-bold">BlueGolf Partner API</strong> enables you to integrate BlueGolf’s data and services directly into your applications, websites, and internal systems. With this API, you can seamlessly retrieve membership, tournament, registration, and participation data to enhance your operations and better serve your players and members.</p><p class="slate-p " >The API is designed with:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Modern RESTful architecture</strong> using JSON payloads.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Secure, scoped access</strong> via API keys with endpoint-level control.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Flexible filtering and query options</strong> to retrieve only the data you need.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Consistent, structured data</strong> to simplify integration with your systems.</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Key Features</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Membership Data:</strong> Retrieve player and member details for your organization. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Participation Tracking:</strong> Access detailed participation and registration statistics. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tournament Data:</strong> Integrate tournament schedules, results, and registration status. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Secure Access:</strong> Endpoint-level permissions ensure data privacy and organizational control. </div></li></ul><p class="slate-p " >Access to specific endpoints will be granted on a per need basis.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Getting Started</h3><p class="slate-p " >To begin using the BlueGolf Partner API:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Contact BlueGolf Support</strong> (support@bluegolf.com) to enable API access and generate your API key.</div></li><li class="slate-li " ><div style="position:relative">BlueGolf will work with you to determine your integration requirements and the endpoints you will need.</div></li><li class="slate-li " ><div style="position:relative">Use your API key in the <code class="slate-code">x-api-key</code> header to authenticate your requests.</div></li><li class="slate-li " ><div style="position:relative">Begin retrieving and posting data securely within your environment.</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Support</h3><p class="slate-p " >BlueGolf is here to assist you throughout your integration. If you need assistance with onboarding, expanding your endpoint access, or troubleshooting, please contact the BlueGolf Support Team (support@bluegolf.com).</p><p class="slate-p " ></p><p class="slate-p " ></p>

This API provides access to a wide range of endpoints that allow you to access and integrate BlueGolf’s data and services into your applications, enabling efficient management of membership, tournaments, and participation information. It’s designed for flexibility, scalability, and ease of integration.

 enables you to integrate BlueGolf’s data and services directly into your applications, websites, and internal systems. With this API, you can seamlessly retrieve membership, tournament, registration, and participation data to enhance your operations and better serve your players and members.

Access to specific endpoints will be granted on a per need basis.

BlueGolf is here to assist you throughout your integration. If you need assistance with onboarding, expanding your endpoint access, or troubleshooting, please contact the BlueGolf Support Team (support@bluegolf.com).

The API key required for authentication and access to the endpoint.

x-api-key

Parent league handle or season league handle. If the parent handle is used, the current season data is returned by default.

customerId

Specify a particular season by providing the season handle.

seasonHandle

Filter results by chapter ID or chapter name as seen in 360.

chapter

Filter results by subregion value as seen in 360.

subregion

handle

Filter results by memberId as an alternative to handle.

memberId

Filter results by pro (Y) or amateur (N) status.

isPro

Bypass "Changes Only" and return a full member set by setting it to "Y".

fullRun

Date used for calculating member age (YYYY-MM-DD). Defaults to the current date if not provided.

dateAgeAsOf

season

tournamentTypes

List of members who have participated in tournaments.

members

Successful response with member participation data.

code

message

Bad request, missing or invalid parameters.

Unauthorized, invalid or missing API key.

<p class="slate-p " >Your API key is configured to access only the specific endpoints approved for your integration with BlueGolf. This <strong class="slate-bold">endpoint-level scoping</strong> ensures secure, intentional data access.</p><p class="slate-p " >If you need to <strong class="slate-bold">add access to additional endpoints</strong>:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Contact BlueGolf Support (support@bluegolf.com) to review your integration needs.</div></li><li class="slate-li " ><div style="position:relative">Discuss which additional endpoints you require and why.</div></li><li class="slate-li " ><div style="position:relative">BlueGolf will evaluate your request and, if approved, expand your API key’s scope to include the new endpoints.</div></li></ol><p class="slate-p " >Once your key is updated, you will be able to access the newly approved endpoints without generating a new API key.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Example Workflow:</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">You identify the need for a new endpoint (e.g., tournament registration data).</div></li><li class="slate-li " ><div style="position:relative">You contact BlueGolf Support (support@bluegolf.com) with the details of your request.</div></li><li class="slate-li " ><div style="position:relative">BlueGolf updates your API key configuration to include the approved endpoint(s).</div></li><li class="slate-li " ><div style="position:relative">You can now call the new endpoint using your existing <code class="slate-code">x-api-key</code>.</div></li></ol><p class="slate-p " ></p><p class="slate-p " ></p>

Your API key is configured to access only the specific endpoints approved for your integration with BlueGolf. This 

 ensures secure, intentional data access.

Once your key is updated, you will be able to access the newly approved endpoints without generating a new API key.

Sections