Overview

Retrieve a list of seasons for a specified association or club organisation.

This includes:

  • Status of the season (Upcoming, Active or Completed) and
  • competition details.

Play HQ Terminology


Terms of use

https://www.playhq.com/terms


Play HQ API credentials

Organisation Seasons 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/organisations/:id/seasons
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 Typ

id

Season’s UUID

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

UUID

name

Name of the season

2021

String (no limit but defined picklist)

status

Season Status

Picklist:

  • Upcoming

  • Active

  • Completed

String (no limit but defined picklist)

createdAt

UTC Timestamp season was created on PlayHQ

2015-08-05T08:40:51.620Z

String

updatedAt

Season last updated at UTC timestamp

2015-08-05T08:40:51.620Z

String

association

Object (defined below)

 

Object

association.id

Association Id

ccc647fa-286a-433b-8284-464c37d6f049

UUID

association.name

Association Name

Keilor Basketball Association

String

association.url

Association URL

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

String

association.logo

Object containing logo properties (defined below)

 

Array

association.logo.sizes

Array of sub objects (defined below)

 

 

association.logo.sizes.url

Logo of Association

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

String

association.logo.sizes.dimensions

Object (defined below)

 

Object

association.logo.sizes.dimensions.width

 

64

Number

association.logo.sizes.dimensions.height

 

64

Number

competition

Object (defined below)

 

Object

competition.id

Competition Id

8e4e71fc-1f3e-4eba-9701-d5f361d2c269

UUID

competition.name

Competition Name

Victorian Junior Basketball League

String

metadata

Object (defined below)

 

Object

metadata.hasMore

 

true

 Boolean

metadata.nextCursor

 

dXNlcjpXMDdRQ1JQQTQ=

 

 

Errors

Scenario

Error Response

Submit an invalid organisation ID

400 - Bad Request

Submit multiple organisation IDs

400 - Bad Request

 

Sample Response

PlayHQ External API

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