📢 The Ask AI can now translate any part of the docs to your preferred language!
Read the guide
sportradar.comSportradar Support Portal

Clubs

The Club is a grouping of teams. The club may share the same administrative structure over all the teams.

Get a list of clubs

get
/icehockey/o/{organizationId}/entityGroups

Return a list of available clubs

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
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
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'
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
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|,)*$
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
/icehockey/o/{organizationId}/entityGroups
GET /v1/icehockey/o/{organizationId}/entityGroups HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "internationalReference": "CA3243-3",
      "status": "ACTIVE",
      "nameFullLocal": "Los Angeles Armadillos",
      "additionalNames": {
        "nameShortLocal": "Armadillos",
        "namePlaceLocal": "Los Angeles",
        "nameShortLatin": "Armadillos",
        "namePlaceLatin": "Los Angeles"
      },
      "nameFullLatin": "Los Angeles Armadillos",
      "codeLocal": "TEST",
      "codeLatin": "TEST",
      "address": {
        "address1": "text",
        "address2": "text",
        "address3": "text",
        "city": "text",
        "state": "text",
        "postalCode": "text",
        "countryCode": "text",
        "longitude": 1,
        "latitude": 1
      },
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "details": {
        "founded": 1,
        "squadValue": 1
      },
      "contacts": {
        "fax": "text",
        "phone": "text",
        "phoneSecondary": "text",
        "email": "[email protected]"
      },
      "colors": {
        "primary": "FFF111",
        "secondary": "FFF111",
        "tertiary": "FFF111"
      },
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameFullLocal": "text",
          "nameFullLatin": "text",
          "nameShortLocal": "text",
          "nameShortLatin": "text",
          "namePlaceLocal": "text"
        }
      ],
      "externalId": "A123",
      "updated": "2025-11-19T05:02:55.853Z",
      "added": "2025-11-19T05:02:55.853Z",
      "defaultVenueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "alternateVenueIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T05:02:55.853Z",
          "added": "2025-11-19T05:02:55.853Z"
        }
      ]
    }
  ]
}

Create a club

post
/icehockey/o/{organizationId}/entityGroups

Create a new club

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
entityGroupIdstring · uuidOptional

The unique identifier of the club

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

The international reference for this club 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 club in the local language

Example: Los Angeles Armadillos
nameFullLatinstring | nullableOptional

The full name of the club in latin characters

Example: Los Angeles Armadillos
codeLocalstring | nullableOptional

The code of the club in the local language

Example: TEST
codeLatinstring | nullableOptional

The code of the club 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/_-]+$
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
/icehockey/o/{organizationId}/entityGroups
POST /v1/icehockey/o/{organizationId}/entityGroups HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1296

{
  "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "internationalReference": "CA3243-3",
  "status": "ACTIVE",
  "nameFullLocal": "Los Angeles Armadillos",
  "additionalNames": {
    "nameShortLocal": "Armadillos",
    "namePlaceLocal": "Los Angeles",
    "nameShortLatin": "Armadillos",
    "namePlaceLatin": "Los Angeles"
  },
  "nameFullLatin": "Los Angeles Armadillos",
  "codeLocal": "TEST",
  "codeLatin": "TEST",
  "address": {
    "address1": "text",
    "address2": "text",
    "address3": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "countryCode": "text",
    "longitude": 1,
    "latitude": 1
  },
  "social": {
    "website": "http://www.example.com",
    "facebook": "https://www.facebook.com/example",
    "twitter": "https://www.twitter.com/example",
    "wikipedia": "https://en.wikipedia.org/wiki/example",
    "instagram": "https://www.instagram.com/example"
  },
  "details": {
    "founded": 1,
    "squadValue": 1
  },
  "contacts": {
    "fax": "text",
    "phone": "text",
    "phoneSecondary": "text",
    "email": "[email protected]"
  },
  "colors": {
    "primary": "FFF111",
    "secondary": "FFF111",
    "tertiary": "FFF111"
  },
  "historicalNames": [
    {
      "dateStart": "2025-11-19",
      "dateEnd": "2025-11-19",
      "nameFullLocal": "text",
      "nameFullLatin": "text",
      "nameShortLocal": "text",
      "nameShortLatin": "text",
      "namePlaceLocal": "text"
    }
  ],
  "externalId": "A123",
  "defaultVenueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "alternateVenueIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "internationalReference": "CA3243-3",
      "status": "ACTIVE",
      "nameFullLocal": "Los Angeles Armadillos",
      "additionalNames": {
        "nameShortLocal": "Armadillos",
        "namePlaceLocal": "Los Angeles",
        "nameShortLatin": "Armadillos",
        "namePlaceLatin": "Los Angeles"
      },
      "nameFullLatin": "Los Angeles Armadillos",
      "codeLocal": "TEST",
      "codeLatin": "TEST",
      "address": {
        "address1": "text",
        "address2": "text",
        "address3": "text",
        "city": "text",
        "state": "text",
        "postalCode": "text",
        "countryCode": "text",
        "longitude": 1,
        "latitude": 1
      },
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "details": {
        "founded": 1,
        "squadValue": 1
      },
      "contacts": {
        "fax": "text",
        "phone": "text",
        "phoneSecondary": "text",
        "email": "[email protected]"
      },
      "colors": {
        "primary": "FFF111",
        "secondary": "FFF111",
        "tertiary": "FFF111"
      },
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameFullLocal": "text",
          "nameFullLatin": "text",
          "nameShortLocal": "text",
          "nameShortLatin": "text",
          "namePlaceLocal": "text"
        }
      ],
      "externalId": "A123",
      "updated": "2025-11-19T05:02:55.853Z",
      "added": "2025-11-19T05:02:55.853Z",
      "defaultVenueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "alternateVenueIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T05:02:55.853Z",
          "added": "2025-11-19T05:02:55.853Z"
        }
      ]
    }
  ]
}

Get a club

get
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Return detailed information about 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
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
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}
GET /v1/icehockey/o/{organizationId}/entityGroups/{entityGroupId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "internationalReference": "CA3243-3",
      "status": "ACTIVE",
      "nameFullLocal": "Los Angeles Armadillos",
      "additionalNames": {
        "nameShortLocal": "Armadillos",
        "namePlaceLocal": "Los Angeles",
        "nameShortLatin": "Armadillos",
        "namePlaceLatin": "Los Angeles"
      },
      "nameFullLatin": "Los Angeles Armadillos",
      "codeLocal": "TEST",
      "codeLatin": "TEST",
      "address": {
        "address1": "text",
        "address2": "text",
        "address3": "text",
        "city": "text",
        "state": "text",
        "postalCode": "text",
        "countryCode": "text",
        "longitude": 1,
        "latitude": 1
      },
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "details": {
        "founded": 1,
        "squadValue": 1
      },
      "contacts": {
        "fax": "text",
        "phone": "text",
        "phoneSecondary": "text",
        "email": "[email protected]"
      },
      "colors": {
        "primary": "FFF111",
        "secondary": "FFF111",
        "tertiary": "FFF111"
      },
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameFullLocal": "text",
          "nameFullLatin": "text",
          "nameShortLocal": "text",
          "nameShortLatin": "text",
          "namePlaceLocal": "text"
        }
      ],
      "externalId": "A123",
      "updated": "2025-11-19T05:02:55.853Z",
      "added": "2025-11-19T05:02:55.853Z",
      "defaultVenueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "alternateVenueIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T05:02:55.853Z",
          "added": "2025-11-19T05:02:55.853Z"
        }
      ]
    }
  ]
}

Update a club

put
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Change the information of a specific club

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
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
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
internationalReferencestring | nullableOptional

The international reference for this club 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 club in the local language

Example: Los Angeles Armadillos
nameFullLatinstring | nullableOptional

The full name of the club in latin characters

Example: Los Angeles Armadillos
codeLocalstring | nullableOptional

The code of the club in the local language

Example: TEST
codeLatinstring | nullableOptional

The code of the club 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/_-]+$
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
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}
PUT /v1/icehockey/o/{organizationId}/entityGroups/{entityGroupId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1241

{
  "internationalReference": "CA3243-3",
  "status": "ACTIVE",
  "nameFullLocal": "Los Angeles Armadillos",
  "additionalNames": {
    "nameShortLocal": "Armadillos",
    "namePlaceLocal": "Los Angeles",
    "nameShortLatin": "Armadillos",
    "namePlaceLatin": "Los Angeles"
  },
  "nameFullLatin": "Los Angeles Armadillos",
  "codeLocal": "TEST",
  "codeLatin": "TEST",
  "address": {
    "address1": "text",
    "address2": "text",
    "address3": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "countryCode": "text",
    "longitude": 1,
    "latitude": 1
  },
  "social": {
    "website": "http://www.example.com",
    "facebook": "https://www.facebook.com/example",
    "twitter": "https://www.twitter.com/example",
    "wikipedia": "https://en.wikipedia.org/wiki/example",
    "instagram": "https://www.instagram.com/example"
  },
  "details": {
    "founded": 1,
    "squadValue": 1
  },
  "contacts": {
    "fax": "text",
    "phone": "text",
    "phoneSecondary": "text",
    "email": "[email protected]"
  },
  "colors": {
    "primary": "FFF111",
    "secondary": "FFF111",
    "tertiary": "FFF111"
  },
  "historicalNames": [
    {
      "dateStart": "2025-11-19",
      "dateEnd": "2025-11-19",
      "nameFullLocal": "text",
      "nameFullLatin": "text",
      "nameShortLocal": "text",
      "nameShortLatin": "text",
      "namePlaceLocal": "text"
    }
  ],
  "externalId": "A123",
  "defaultVenueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "alternateVenueIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "internationalReference": "CA3243-3",
      "status": "ACTIVE",
      "nameFullLocal": "Los Angeles Armadillos",
      "additionalNames": {
        "nameShortLocal": "Armadillos",
        "namePlaceLocal": "Los Angeles",
        "nameShortLatin": "Armadillos",
        "namePlaceLatin": "Los Angeles"
      },
      "nameFullLatin": "Los Angeles Armadillos",
      "codeLocal": "TEST",
      "codeLatin": "TEST",
      "address": {
        "address1": "text",
        "address2": "text",
        "address3": "text",
        "city": "text",
        "state": "text",
        "postalCode": "text",
        "countryCode": "text",
        "longitude": 1,
        "latitude": 1
      },
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "details": {
        "founded": 1,
        "squadValue": 1
      },
      "contacts": {
        "fax": "text",
        "phone": "text",
        "phoneSecondary": "text",
        "email": "[email protected]"
      },
      "colors": {
        "primary": "FFF111",
        "secondary": "FFF111",
        "tertiary": "FFF111"
      },
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameFullLocal": "text",
          "nameFullLatin": "text",
          "nameShortLocal": "text",
          "nameShortLatin": "text",
          "namePlaceLocal": "text"
        }
      ],
      "externalId": "A123",
      "updated": "2025-11-19T05:02:55.853Z",
      "added": "2025-11-19T05:02:55.853Z",
      "defaultVenueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "alternateVenueIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T05:02:55.853Z",
          "added": "2025-11-19T05:02:55.853Z"
        }
      ]
    }
  ]
}

Delete a club

delete
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Delete a specific club

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
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
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
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}
DELETE /v1/icehockey/o/{organizationId}/entityGroups/{entityGroupId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "internationalReference": "CA3243-3",
      "status": "ACTIVE",
      "nameFullLocal": "Los Angeles Armadillos",
      "additionalNames": {
        "nameShortLocal": "Armadillos",
        "namePlaceLocal": "Los Angeles",
        "nameShortLatin": "Armadillos",
        "namePlaceLatin": "Los Angeles"
      },
      "nameFullLatin": "Los Angeles Armadillos",
      "codeLocal": "TEST",
      "codeLatin": "TEST",
      "address": {
        "address1": "text",
        "address2": "text",
        "address3": "text",
        "city": "text",
        "state": "text",
        "postalCode": "text",
        "countryCode": "text",
        "longitude": 1,
        "latitude": 1
      },
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "details": {
        "founded": 1,
        "squadValue": 1
      },
      "contacts": {
        "fax": "text",
        "phone": "text",
        "phoneSecondary": "text",
        "email": "[email protected]"
      },
      "colors": {
        "primary": "FFF111",
        "secondary": "FFF111",
        "tertiary": "FFF111"
      },
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameFullLocal": "text",
          "nameFullLatin": "text",
          "nameShortLocal": "text",
          "nameShortLatin": "text",
          "namePlaceLocal": "text"
        }
      ],
      "externalId": "A123",
      "updated": "2025-11-19T05:02:55.853Z",
      "added": "2025-11-19T05:02:55.853Z",
      "defaultVenueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "alternateVenueIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T05:02:55.853Z",
          "added": "2025-11-19T05:02:55.853Z"
        }
      ]
    }
  ]
}
PreviousTeamsNextMatch Progressions

Last updated

Was this helpful?