Restricted access

Private APIs are those which include Authorization required (for a Bearer {JWT_Auth_Token}). These Private APIs are restricted and only accessible to approved PlayHQ partners.

PlayHQ offer a vast amount of data relating to competition fixtures, results and ladder within the available public APIs.

For a detailed list, look for endpoints labelled with "GET" in the PlayHQ API documentation.

Private APIs are those which include Authorization required (for a Bearer {JWT_Auth_Token}), and only approved PlayHQ partners will have access.

Organisation IDs are 32-digit unique identifiers (UUID) not readily visible on the website. To obtain one:

1. Contact your league or club administrator
2. Once you have the Organisation ID, you can use it to call various APIs:
   • Using the Organisation ID, call "Seasons for organisation" to retrieve season ID's.
   • Using a season ID, Call "Grades for season" to retrieve grade ID's.
   • Using a grade ID, call “fixture for grade” to retrieve game ids.
   • Using a game ID, call “Summary for game (Public)” to get results for a game.

There is a different base URL by locality in PlayHQ Production.

AUS & NZ Regions: https://api.playhq.com

UK & EU Regions: https://api.euprod.playhq.com

CA Region: https://api.caprod.playhq.com 

If you have been granted access to our AUS & NZ UAT environments, the PlayHQ API Server URL in UAT is: https://api.uat.playhq.com

Complete endpoint information for each API can be found in the PlayHQ API documentation.

If you're finding incomplete or missing data in your API responses, you're likely encountering pagination. For endpoints that may return large datasets, PlayHQ API implements cursor-based pagination (typically 100 items) to maintain performance. To retrieve the complete dataset, you'll need to make multiple requests.

Where metadata.hasMore is true in your API response, then there are more responses available for your request, which can be accessed with a cursor parameter. This should allow you to paginate through all available results by continuing to make requests with the latest cursor value until you receive a response where the metadata: hasMore is false.

To retrieve all available data:

1. Make your initial API request to the endpoint
2. Check if metadata.hasMore is true in the response
3. If yes, make another request to the same endpoint, adding the cursor parameter (i.e. ?cursor=) with the metadata.nextCursor value after = from the previous response
4. Continue this process, collecting all results, until you receive a response where metadata.hasMore is false

Example:

// First request
GET https://api.playhq.com/v1/{endpoint}

// Response includes metadata.hasMore: true and metadata.nextCursor value
// Make subsequent request with cursor
GET https://api.playhq.com/v1/{endpoint}?cursor={cursor_value}
      

Always check for the metadata fields in your responses to ensure you're retrieving complete datasets.