Teams

The Team is a grouping of persons who compete together in a match. The team can compete in multiple competitions simultaneously over multiple seasons. They exist in only one organization. The team can optionally be part of one club.

Get a list of teams

get
/baseball/o/{organizationId}/entities

Return a list of available teams

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
ageGroupstring · enumOptional

The age group of the season

  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
disciplinestring · enum · max: 30Optional

The discipline for a match

  • BEACH Beach
  • HOCKEY5S Hockey5s
  • INDOOR Indoor
  • OUTDOOR Outdoor
  • PARAHOCKEY Para hockey
Example: INDOORPossible values:
entityIdstringOptional

The unique identifier of the entity. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
genderstring · enumOptional

The gender of the season or team

  • FEMALE Female
  • MALE Male
  • MIXED Mixed
  • UNKNOWN Unknown
Example: MALEPossible values:
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
nameFullLatinstring · max: 50Optional

The full name of the person in latin characters

nameFullLatinContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLatin=David Johnson nameFullLatinContains=Dav will match nameFullLatinContains=John will match nameFullLatinContains=son will not match

Example: Dav and nameFullLatin='David Johnson'
nameFullLocalstring · max: 50Optional

The full name of the person

nameFullLocalContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLocal=David Johnson nameFullLocalContains=Dav will match nameFullLocalContains=John will match nameFullLocalContains=son will not match

Example: Dav and nameFullLocal='David Johnson'
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
representingstring · max: 100Optional

Who the person was representing

Example: AUSTRALIA
representingCountrystring · enumOptional

What country representation is used

  • ANY Any country
  • NONE No country
Possible values:
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -nameFullLocal,nameFullLatinPattern: ^(\-?nameFullLocal|\-?nameFullLatin|,)*$
standardstring · enum · max: 50Optional

The playing standard of the team

  • ELITE Professional/elite organisation
  • FRIENDLY International Friendly
  • GRASS_ROOT Normal
  • HOCKEY_SERIES_OPEN Hockey Series Open
  • INTERNATIONAL International
  • NONCONTINENTAL_CHAMPIONSHIP Non-continental Championship
  • OLYMPIC Olympics
  • REGION Regional
  • TIER2 lesser standard than elite
  • TIER3 lesser standard than tier 2
  • WORLD_CHAMPIONSHIP World Championship
  • WORLD_LEAGUE World League
  • ZONE_CHAMPIONSHIP International Zone Championship
Example: ELITEPossible values:
statusstring · enumOptional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
200

Successful operation

application/json
get
/baseball/o/{organizationId}/entities

Create a team

post
/baseball/o/{organizationId}/entities

Add a new team

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
entityIdstring · uuidOptional

The unique identifier of the team

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
entityGroupIdstring · uuid | nullableOptional

The club that this team belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
internationalReferencestring | nullableOptional

The international reference for this team given by the sport governing body

Example: CA3243-3
statusstring · enum · max: 30Required

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
nameFullLocalstring · max: 150Required

The full name of the team in the local language

Example: Los Angeles Armadillos
nameFullLatinstring | nullableOptional

The full name of the team in latin characters

Example: Los Angeles Armadillos
codeLocalstring | nullableOptional

The code of the team in the local language

Example: TEST
codeLatinstring | nullableOptional

The code of the team in latin characters

Example: TEST
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
ageGroupstring · enum | nullableOptional

The age group of the team

  • None None
  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_10 Under 10
  • UNDER_11 Under 11
  • UNDER_12 Under 12
  • UNDER_13 Under 13
  • UNDER_14 Under 14
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
genderstring · enum | nullableOptional

The gender of the participants in the team

  • None None
  • FEMALE Female
  • MALE Male
  • MIXED Mixed
  • UNKNOWN Unknown
Example: MALEPossible values:
standardstring · enum | nullableOptional

The playing standard of the team

  • None None
  • ELITE Professional/elite organisation
  • FRIENDLY International Friendly
  • GRASS_ROOT Normal
  • INTERNATIONAL International
  • NONCONTINENTAL_CHAMPIONSHIP Non-continental Championship
  • OLYMPIC Olympics
  • REGION Regional
  • TIER2 lesser standard than elite
  • TIER3 lesser standard than tier 2
  • WORLD_CHAMPIONSHIP World Championship
  • ZONE_CHAMPIONSHIP International Zone Championship
Example: ELITEPossible values:
gradestring | nullableOptional

The playing grade of the matches for this team

Example: A
representingstring | nullableOptional

Who the team was representing

Example: AUSTRALIA
disciplinestring · enum | nullableOptional

Discipline' the team participates in

  • None None
  • INDOOR Indoor
  • OUTDOOR Outdoor
Example: INDOORPossible values:
defaultVenueIdstring · uuid | nullableOptional

The unique identifier of the default venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
alternateVenueIdsstring · uuid[]Optional
Responses
200

Successful operation

application/json
post
/baseball/o/{organizationId}/entities

Get a list of teams for a club

get
/baseball/o/{organizationId}/entityGroups/{entityGroupId}/entities

Return a list of available teams linked to a specific club

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityGroupIdstring · uuidRequired

The unique identifier of the entity group

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
ageGroupstring · enumOptional

The age group of the season

  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
disciplinestring · enum · max: 30Optional

The discipline for a match

  • BEACH Beach
  • HOCKEY5S Hockey5s
  • INDOOR Indoor
  • OUTDOOR Outdoor
  • PARAHOCKEY Para hockey
Example: INDOORPossible values:
entityIdstringOptional

The unique identifier of the entity. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
genderstring · enumOptional

The gender of the season or team

  • FEMALE Female
  • MALE Male
  • MIXED Mixed
  • UNKNOWN Unknown
Example: MALEPossible values:
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
nameFullLatinstring · max: 50Optional

The full name of the person in latin characters

nameFullLocalstring · max: 50Optional

The full name of the person

offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
standardstring · enum · max: 50Optional

The playing standard of the team

  • ELITE Professional/elite organisation
  • FRIENDLY International Friendly
  • GRASS_ROOT Normal
  • HOCKEY_SERIES_OPEN Hockey Series Open
  • INTERNATIONAL International
  • NONCONTINENTAL_CHAMPIONSHIP Non-continental Championship
  • OLYMPIC Olympics
  • REGION Regional
  • TIER2 lesser standard than elite
  • TIER3 lesser standard than tier 2
  • WORLD_CHAMPIONSHIP World Championship
  • WORLD_LEAGUE World League
  • ZONE_CHAMPIONSHIP International Zone Championship
Example: ELITEPossible values:
statusstring · enumOptional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
200

Successful operation

application/json
get
/baseball/o/{organizationId}/entityGroups/{entityGroupId}/entities

Get a team

get
/baseball/o/{organizationId}/entities/{entityId}

Return detailed information about a specific team

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityIdstring · uuidRequired

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
200

Successful operation

application/json
get
/baseball/o/{organizationId}/entities/{entityId}

Update a team

put
/baseball/o/{organizationId}/entities/{entityId}

Change the information of a specific team

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityIdstring · uuidRequired

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
entityGroupIdstring · uuid | nullableOptional

The club that this team belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
internationalReferencestring | nullableOptional

The international reference for this team given by the sport governing body

Example: CA3243-3
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
nameFullLocalstring · max: 150Optional

The full name of the team in the local language

Example: Los Angeles Armadillos
nameFullLatinstring | nullableOptional

The full name of the team in latin characters

Example: Los Angeles Armadillos
codeLocalstring | nullableOptional

The code of the team in the local language

Example: TEST
codeLatinstring | nullableOptional

The code of the team in latin characters

Example: TEST
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
ageGroupstring · enum | nullableOptional

The age group of the team

  • None None
  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_10 Under 10
  • UNDER_11 Under 11
  • UNDER_12 Under 12
  • UNDER_13 Under 13
  • UNDER_14 Under 14
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
genderstring · enum | nullableOptional

The gender of the participants in the team

  • None None
  • FEMALE Female
  • MALE Male
  • MIXED Mixed
  • UNKNOWN Unknown
Example: MALEPossible values:
standardstring · enum | nullableOptional

The playing standard of the team

  • None None
  • ELITE Professional/elite organisation
  • FRIENDLY International Friendly
  • GRASS_ROOT Normal
  • INTERNATIONAL International
  • NONCONTINENTAL_CHAMPIONSHIP Non-continental Championship
  • OLYMPIC Olympics
  • REGION Regional
  • TIER2 lesser standard than elite
  • TIER3 lesser standard than tier 2
  • WORLD_CHAMPIONSHIP World Championship
  • ZONE_CHAMPIONSHIP International Zone Championship
Example: ELITEPossible values:
gradestring | nullableOptional

The playing grade of the matches for this team

Example: A
representingstring | nullableOptional

Who the team was representing

Example: AUSTRALIA
disciplinestring · enum | nullableOptional

Discipline' the team participates in

  • None None
  • INDOOR Indoor
  • OUTDOOR Outdoor
Example: INDOORPossible values:
defaultVenueIdstring · uuid | nullableOptional

The unique identifier of the default venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
alternateVenueIdsstring · uuid[]Optional
Responses
200

Successful operation

application/json
put
/baseball/o/{organizationId}/entities/{entityId}

Delete a team

delete
/baseball/o/{organizationId}/entities/{entityId}

Delete a specific team

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityIdstring · uuidRequired

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
delete
/baseball/o/{organizationId}/entities/{entityId}

Last updated

Was this helpful?