Overview

Retrieve a list of teams participating under a specified season

This includes:

  • Club and grade information for each team.

Play HQ Terminology


Terms of use

https://www.playhq.com/terms


Play HQ API credentials

Season Teams uses API keys to authenticate requests. To request API credentials please contact support@playhq.com

Once you have received your credentials from Play HQ you will be able to generate an authentication token. More information on how to do this can be found here.


Resources

Get Request

GET v1/seasons/:id/teams
Information on Path and Header parameters can be found here.

Data included in a successful response

Field Name in File

Field Description

Sample Data (or picklist values, if appropriate)

Database Field Type

id

Team’s UUID

88a5b302-f71f-11ea-adc1-0242ac120002

UUID

name

Name of the team

Sharkies

String

createdAt

Team Created At timestamp

2015-08-05T08:40:51.620Z

String

updatedAt

Team last updated at timestamp

2015-08-05T08:40:51.620Z

String

club

Object (defined below)

 

Object

club.id

Club Id

8ff76c62-ad92-4991-b160-9fe9d12476d2

UUID

club.name

Club name

Keilor Thunder

String

club.url

URL for Club

https://www.playhq.com/basketball-victoria/org/keilor-basketball-club/ccc647fa

 

club.logo

Object containing logo parameters (defined below)

 

Array

club.logo.sizes

Array of sub objects (defined below)

 

 

club.logo.sizes.url

Logo of Club

https://assets.playhq.com/bv/ccc647/64_64_logo.png

String

club.logo.sizes.dimensions

Object (defined below)

 

Object

club.logo.sizes.dimensions.width

 

64

Number

club.logo.sizes.dimensions.height

 

64

Number

grade

Object (defined below)

 

Object

grade.id

Grade's UUID

88a5b302-f71f-11ea-adc1-0242ac120002

UUID

grade.name

Grade name

12 Boys - VJL2 (P2)

String

grade.url

URL of grade

https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768

 

metadata

Object (defined below)

 

Object

metadata.hasMore

 

true

Boolean

metadata.nextCursor

 

dXNlcjpXMDdRQ1JQQTQ=

 

 

Errors

Scenario

Error Response

Submit an invalid season ID

400 - Bad Request

Submit multiple season IDs

400 - Bad Request

 

Sample Response

PlayHQ External API

Was this article helpful?
0 out of 0 found this helpful