Teams List Collection by organisation ID

Overview

Retrieve a list of teams for a specified association.

This includes:

  • Competition, season and grade information for each team attached to the Organisation ID.

All data can be retrieved in real time but certain information may not be available until the fixture or game has been finalised.

Play HQ Terminology


Terms of use

https://www.playhq.com/terms


Play HQ API credentials

The Teams List Collection 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 partner/v1/organisations/: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 Typ

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 of Club

 

 

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

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 parameters (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

season

Object (defined below)

 

Object

season.id

Season ID

11ed119a-cb8f-4faa-a338-cb714ba97a8c

UUID

season.name

Season Name

2021

String (no limit but defined picklist)

season.url

Season URL

https://www.playhq.com/basketball-victoria/org/keilor-basketball-association/junior-domestic-winter-2021/8e4e71fc

 

season.status

Season Status

Picklist:

  • Upcoming

  • Active

  • Completed

String (no limit but defined picklist)

grade

Object (defined below)

 

Object

grade.id

Grade ID

d1f9c41d-cb8f-4faa-a338-cb714ba97a8c

UUID

grade.name

Grade Name

12 Boys - VJL2 (P2)

String

grade.url

Grade URL

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 game ID

400 - Bad Request

Submit multiple game IDs

400 - Bad Request

Unauthorised submission for a valid organisation ID on a valid date via the private endpoint

TBC

Authorised submission for a specific club organisation ID via the private endpoint

TBC

 

Sample Response

PlayHQ External API

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