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

Site external IDs

Get a list of a site external ids

get
/hockey/o/{organizationId}/sites/externalids

A list of site external ids

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
offsetinteger · int32Optional

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

Example: 10
siteIdstringOptional

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

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sourcestring · max: 100Optional

Source of external Id

sourceExternalIdstring · max: 100Optional

external Id of the external source

sourceTypestring · max: 30Optional

Source type of external Id

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
/hockey/o/{organizationId}/sites/externalids
GET /v1/hockey/o/{organizationId}/sites/externalids 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": [
    {
      "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "site": {
        "resourceType": "sites",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "source": "urn:sources:sportradar.com",
      "sourceType": "text",
      "sourceExternalId": "SR:123",
      "updated": "2025-11-19T05:50:04.086Z",
      "added": "2025-11-19T05:50:04.086Z"
    }
  ]
}

Create a new external identifier information record for a site

post
/hockey/o/{organizationId}/sites/externalids

Add a new external identifier information record for a site

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

The unique identifier of the external ids

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
siteIdstring · uuidOptional

The site that this site external ids belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sourcestring · max: 100Required

The source of the external Id

Example: urn:sources:sportradar.com
sourceTypestringRequired

Source type of external Id

sourceExternalIdstring · max: 100Required

Identifier of external source

Example: SR:123
Responses
200

Successful operation

application/json
post
/hockey/o/{organizationId}/sites/externalids
POST /v1/hockey/o/{organizationId}/sites/externalids HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "source": "urn:sources:sportradar.com",
  "sourceType": "text",
  "sourceExternalId": "SR:123"
}
{
  "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": [
    {
      "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "site": {
        "resourceType": "sites",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "source": "urn:sources:sportradar.com",
      "sourceType": "text",
      "sourceExternalId": "SR:123",
      "updated": "2025-11-19T05:50:04.086Z",
      "added": "2025-11-19T05:50:04.086Z"
    }
  ]
}

Get a site external identifier details

get
/hockey/o/{organizationId}/sites/externalids/{siteExternalId}

Detailed information about a specific site external identifier

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
siteExternalIdstring · uuidRequired

The unique identifier of site external Id

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
/hockey/o/{organizationId}/sites/externalids/{siteExternalId}
GET /v1/hockey/o/{organizationId}/sites/externalids/{siteExternalId} 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": [
    {
      "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "site": {
        "resourceType": "sites",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "source": "urn:sources:sportradar.com",
      "sourceType": "text",
      "sourceExternalId": "SR:123",
      "updated": "2025-11-19T05:50:04.086Z",
      "added": "2025-11-19T05:50:04.086Z"
    }
  ]
}

Update a site external identifier information

put
/hockey/o/{organizationId}/sites/externalids/{siteExternalId}

Change the external identifier information of a specific site

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
siteExternalIdstring · uuidRequired

The unique identifier of site external Id

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
siteIdstring · uuidOptional

The site that this site external ids belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sourcestring · max: 100Optional

The source of the external Id

Example: urn:sources:sportradar.com
sourceTypestringOptional

Source type of external Id

sourceExternalIdstring · max: 100Optional

Identifier of external source

Example: SR:123
Responses
200

Successful operation

application/json
put
/hockey/o/{organizationId}/sites/externalids/{siteExternalId}
PUT /v1/hockey/o/{organizationId}/sites/externalids/{siteExternalId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "source": "urn:sources:sportradar.com",
  "sourceType": "text",
  "sourceExternalId": "SR:123"
}
{
  "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": [
    {
      "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "site": {
        "resourceType": "sites",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "source": "urn:sources:sportradar.com",
      "sourceType": "text",
      "sourceExternalId": "SR:123",
      "updated": "2025-11-19T05:50:04.086Z",
      "added": "2025-11-19T05:50:04.086Z"
    }
  ]
}

Delete a site external identifier information

delete
/hockey/o/{organizationId}/sites/externalids/{siteExternalId}

Delete a specific site external identifier information

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
siteExternalIdstring · uuidRequired

The unique identifier of site external Id

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
/hockey/o/{organizationId}/sites/externalids/{siteExternalId}
DELETE /v1/hockey/o/{organizationId}/sites/externalids/{siteExternalId} 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": [
    {
      "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "site": {
        "resourceType": "sites",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "source": "urn:sources:sportradar.com",
      "sourceType": "text",
      "sourceExternalId": "SR:123",
      "updated": "2025-11-19T05:50:04.086Z",
      "added": "2025-11-19T05:50:04.086Z"
    }
  ]
}

Create/Update a new external identifier information record for a site

post
/hockey/o/{organizationId}/sites/externalids/force

Depending on data, Add new external identifier information record for a site or update an existing one

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

The unique identifier of the external ids

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
siteIdstring · uuidOptional

The site that this site external ids belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sourcestring · max: 100Required

The source of the external Id

Example: urn:sources:sportradar.com
sourceTypestringRequired

Source type of external Id

sourceExternalIdstring · max: 100Required

Identifier of external source

Example: SR:123
Responses
200

Successful operation

application/json
post
/hockey/o/{organizationId}/sites/externalids/force
POST /v1/hockey/o/{organizationId}/sites/externalids/force HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "source": "urn:sources:sportradar.com",
  "sourceType": "text",
  "sourceExternalId": "SR:123"
}
{
  "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": [
    {
      "siteExternalId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "siteId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "site": {
        "resourceType": "sites",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "source": "urn:sources:sportradar.com",
      "sourceType": "text",
      "sourceExternalId": "SR:123",
      "updated": "2025-11-19T05:50:04.086Z",
      "added": "2025-11-19T05:50:04.086Z"
    }
  ]
}
PreviousClub external IDsNextDivision external IDs

Last updated

Was this helpful?