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

Match Persons

A match involves a number of persons. The persons assigned to a match are controlled by these calls.

Get a list of persons in the match

get
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons

Return a list of persons for a match

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

The unique identifier of the fixture

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
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
updatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
Responses
get
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons
GET /v1/hockey/o/{organizationId}/fixtures/{fixtureId}/persons 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": [
    {
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "isHome": true,
      "draw": true,
      "resultStatus": "CONFIRMED",
      "resultPlace": 1,
      "resultSecondaryScorePlace": 1,
      "startingNumber": 1,
      "score": "98",
      "secondaryScore": "3v3",
      "isNeutralVenue": true,
      "includeInRepresentation": true,
      "uniformId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "uniform": {
        "resourceType": "uniforms",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "externalId": "A123",
      "updated": "2025-11-19T05:43:12.344Z",
      "added": "2025-11-19T05:43:12.344Z"
    }
  ]
}

Add or Update a person in a match

post
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons

Depending on primary keys, Add a person or update an existing person in a match

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

The unique identifier of the fixture

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

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
personIdstring · uuidRequired

The unique identifier of the person

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

The club that this team belongs to

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

Is competitor the home person ?

Example: true
drawbooleanOptional

Result for this competitor was a draw ?

Example: true
resultStatusstring · enum · max: 100Required

Result status

  • CONFIRMED Confirmed
  • DID_NOT_FINISH Did Not Finish
  • DID_NOT_START Did Not Start
  • DISQUALIFIED Disqualified
  • FORFEITED Forfeited
  • IN_PROGRESS In Progress
  • SCHEDULED Scheduled
  • WITHDRAWN Withdrawn
  • WON_BY_FORFEIT Won By Forfeit
Example: CONFIRMEDPossible values:
resultPlaceinteger · int32 | nullableOptional

Result placing (1=Won, 2=Lost)

Example: 1
resultSecondaryScorePlaceinteger · int32 | nullableOptional

Result placing (1=Won, 2=Lost) of the Shoot Out

Example: 1
startingNumberinteger · int32 | nullableOptional

Starting number

Example: 1
scorestring | nullableOptional

Score for competitor in match

Example: 98
secondaryScorestring | nullableOptional

Secondary score

Example: 3v3
isNeutralVenuebooleanOptional

Competitor is playing at a neutral venue ?

Example: true
includeInRepresentationbooleanOptional

Include this match in represented statistics?

Default: trueExample: true
uniformIdstring · uuid | nullableOptional

The unique identifier of the uniform

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

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

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
Responses
post
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons
POST /v1/hockey/o/{organizationId}/fixtures/{fixtureId}/persons HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "isHome": true,
  "draw": true,
  "resultStatus": "CONFIRMED",
  "resultPlace": 1,
  "resultSecondaryScorePlace": 1,
  "startingNumber": 1,
  "score": "98",
  "secondaryScore": "3v3",
  "isNeutralVenue": true,
  "includeInRepresentation": true,
  "uniformId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "externalId": "A123"
}
{
  "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": [
    {
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "isHome": true,
      "draw": true,
      "resultStatus": "CONFIRMED",
      "resultPlace": 1,
      "resultSecondaryScorePlace": 1,
      "startingNumber": 1,
      "score": "98",
      "secondaryScore": "3v3",
      "isNeutralVenue": true,
      "includeInRepresentation": true,
      "uniformId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "uniform": {
        "resourceType": "uniforms",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "externalId": "A123",
      "updated": "2025-11-19T05:43:12.344Z",
      "added": "2025-11-19T05:43:12.344Z"
    }
  ]
}

Get a person in a match

get
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons/{personId}

Return the detail of a specific person in a match

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

The unique identifier of the fixture

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

The unique identifier of the organization

Example: b1a23
personIdstring · uuidRequired

The unique identifier of the person

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
get
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons/{personId}
GET /v1/hockey/o/{organizationId}/fixtures/{fixtureId}/persons/{personId} 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": [
    {
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "isHome": true,
      "draw": true,
      "resultStatus": "CONFIRMED",
      "resultPlace": 1,
      "resultSecondaryScorePlace": 1,
      "startingNumber": 1,
      "score": "98",
      "secondaryScore": "3v3",
      "isNeutralVenue": true,
      "includeInRepresentation": true,
      "uniformId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "uniform": {
        "resourceType": "uniforms",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "externalId": "A123",
      "updated": "2025-11-19T05:43:12.344Z",
      "added": "2025-11-19T05:43:12.344Z"
    }
  ]
}

Delete a person from a match

delete
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons/{personId}

Delete a specific person from a match

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

The unique identifier of the fixture

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

The unique identifier of the organization

Example: b1a23
personIdstring · uuidRequired

The unique identifier of the person

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
delete
/hockey/o/{organizationId}/fixtures/{fixtureId}/persons/{personId}
DELETE /v1/hockey/o/{organizationId}/fixtures/{fixtureId}/persons/{personId} 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": [
    {
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "isHome": true,
      "draw": true,
      "resultStatus": "CONFIRMED",
      "resultPlace": 1,
      "resultSecondaryScorePlace": 1,
      "startingNumber": 1,
      "score": "98",
      "secondaryScore": "3v3",
      "isNeutralVenue": true,
      "includeInRepresentation": true,
      "uniformId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "uniform": {
        "resourceType": "uniforms",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "externalId": "A123",
      "updated": "2025-11-19T05:43:12.344Z",
      "added": "2025-11-19T05:43:12.344Z"
    }
  ]
}
PreviousMatch TeamsNextMatch Roster

Last updated

Was this helpful?