Transfers

A transfers is a collection of person movements between ~~entity_groups~~.

Get a list of transfers

get

/ice3/o/{organizationId}/transfers

Return a list of transfers~

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

competitionIdstring · uuidOptional

The unique identifier of the competition

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)]

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

seasonIdstring · uuidOptional

The unique identifier of the season

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

transferTypestring · enum · max: 100Optional

Type of transfer

DROPPED Dropped

OTHER Other

PERMIT Permit

TRADE Trade

TRANSFER Transfer

Example: TRANSFERPossible 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

default

Error

application/json

get

/ice3/o/{organizationId}/transfers

GET /v1/ice3/o/{organizationId}/transfers 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": [
    {
      "transferId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "competition": {
        "resourceType": "competitions",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "components": [
        {
          "personId": "text",
          "fromEntityGroupId": "text",
          "toEntityGroupId": "text",
          "extraAllowances": "Cash, 1st Round Pick"
        }
      ],
      "status": "APPROVED",
      "reference": "text",
      "transferType": "TRANSFER",
      "dateTransfer": "1978-08-24",
      "datePermitFrom": "1978-08-24",
      "datePermitTo": "1978-08-24",
      "notes": "text",
      "externalId": "A123",
      "updated": "2026-01-08T19:02:42.946Z",
      "added": "2026-01-08T19:02:42.946Z"
    }
  ]
}

Create a transfer

post

/ice3/o/{organizationId}/transfers

Add a new transfer

Required scopes

This endpoint requires the following scopes:

: Write/Update any data from below the organization

Authorizations

OAuth2clientCredentialsRequired

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

transferIdstring · uuidOptional

The unique identifier of the transfer

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

competitionIdstring · uuidOptional

The unique identifier of the competition

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

seasonIdstring · uuidOptional

The unique identifier of the season

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

statusstring · enum | nullableOptional

Transfer Status

None None

APPROVED Approved

DECLINED Decline

PENDING Pending

Example: APPROVEDPossible values:

referencestring · max: 100Optional

Transfer reference number

transferTypestring · enum · max: 100Required

Type of transfer

DROPPED Dropped

OTHER Other

PERMIT Permit

TRADE Trade

TRANSFER Transfer

Example: TRANSFERPossible values:

dateTransferstring · date | nullableOptional

Date of transfer

Example: 1978-08-24

datePermitFromstring · date | nullableOptional

Date the permit started

Example: 1978-08-24

datePermitTostring · date | nullableOptional

Date the permit ended

Example: 1978-08-24

notesstring | nullableOptional

Notes

externalIdstring | nullableOptional

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

Example: A123Pattern: ^[0-9A-Za-z/_-]+$

Responses

200

Successful operation

application/json

default

Error

application/json

post

/ice3/o/{organizationId}/transfers

POST /v1/ice3/o/{organizationId}/transfers HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 472

{
  "transferId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "components": [
    {
      "personId": "text",
      "fromEntityGroupId": "text",
      "toEntityGroupId": "text",
      "extraAllowances": "Cash, 1st Round Pick"
    }
  ],
  "status": "APPROVED",
  "reference": "text",
  "transferType": "TRANSFER",
  "dateTransfer": "1978-08-24",
  "datePermitFrom": "1978-08-24",
  "datePermitTo": "1978-08-24",
  "notes": "text",
  "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": [
    {
      "transferId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "competition": {
        "resourceType": "competitions",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "components": [
        {
          "personId": "text",
          "fromEntityGroupId": "text",
          "toEntityGroupId": "text",
          "extraAllowances": "Cash, 1st Round Pick"
        }
      ],
      "status": "APPROVED",
      "reference": "text",
      "transferType": "TRANSFER",
      "dateTransfer": "1978-08-24",
      "datePermitFrom": "1978-08-24",
      "datePermitTo": "1978-08-24",
      "notes": "text",
      "externalId": "A123",
      "updated": "2026-01-08T19:02:42.946Z",
      "added": "2026-01-08T19:02:42.946Z"
    }
  ]
}

Get a transfer

get

/ice3/o/{organizationId}/transfers/{transferId}

Return detailed information about a specific transfer

Required scopes

This endpoint requires the following scopes:

: Read any data from the organization down

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23

transferIdstring · uuidRequired

The unique identifier of the transfer record

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

default

Error

application/json

get

/ice3/o/{organizationId}/transfers/{transferId}

GET /v1/ice3/o/{organizationId}/transfers/{transferId} 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": [
    {
      "transferId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "competition": {
        "resourceType": "competitions",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "components": [
        {
          "personId": "text",
          "fromEntityGroupId": "text",
          "toEntityGroupId": "text",
          "extraAllowances": "Cash, 1st Round Pick"
        }
      ],
      "status": "APPROVED",
      "reference": "text",
      "transferType": "TRANSFER",
      "dateTransfer": "1978-08-24",
      "datePermitFrom": "1978-08-24",
      "datePermitTo": "1978-08-24",
      "notes": "text",
      "externalId": "A123",
      "updated": "2026-01-08T19:02:42.946Z",
      "added": "2026-01-08T19:02:42.946Z"
    }
  ]
}

Update a transfer

put

/ice3/o/{organizationId}/transfers/{transferId}

Change the information of a specific transfer

Required scopes

This endpoint requires the following scopes:

: Write/Update any data from below the organization

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23

transferIdstring · uuidRequired

The unique identifier of the transfer record

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

competitionIdstring · uuidOptional

The unique identifier of the competition

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

seasonIdstring · uuidOptional

The unique identifier of the season

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

statusstring · enum | nullableOptional

Transfer Status

None None

APPROVED Approved

DECLINED Decline

PENDING Pending

Example: APPROVEDPossible values:

referencestring · max: 100Optional

Transfer reference number

transferTypestring · enum · max: 100Optional

Type of transfer

DROPPED Dropped

OTHER Other

PERMIT Permit

TRADE Trade

TRANSFER Transfer

Example: TRANSFERPossible values:

dateTransferstring · date | nullableOptional

Date of transfer

Example: 1978-08-24

datePermitFromstring · date | nullableOptional

Date the permit started

Example: 1978-08-24

datePermitTostring · date | nullableOptional

Date the permit ended

Example: 1978-08-24

notesstring | nullableOptional

Notes

externalIdstring | nullableOptional

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

Example: A123Pattern: ^[0-9A-Za-z/_-]+$

Responses

200

Successful operation

application/json

default

Error

application/json

put

/ice3/o/{organizationId}/transfers/{transferId}

PUT /v1/ice3/o/{organizationId}/transfers/{transferId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 420

{
  "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "components": [
    {
      "personId": "text",
      "fromEntityGroupId": "text",
      "toEntityGroupId": "text",
      "extraAllowances": "Cash, 1st Round Pick"
    }
  ],
  "status": "APPROVED",
  "reference": "text",
  "transferType": "TRANSFER",
  "dateTransfer": "1978-08-24",
  "datePermitFrom": "1978-08-24",
  "datePermitTo": "1978-08-24",
  "notes": "text",
  "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": [
    {
      "transferId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "competition": {
        "resourceType": "competitions",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "components": [
        {
          "personId": "text",
          "fromEntityGroupId": "text",
          "toEntityGroupId": "text",
          "extraAllowances": "Cash, 1st Round Pick"
        }
      ],
      "status": "APPROVED",
      "reference": "text",
      "transferType": "TRANSFER",
      "dateTransfer": "1978-08-24",
      "datePermitFrom": "1978-08-24",
      "datePermitTo": "1978-08-24",
      "notes": "text",
      "externalId": "A123",
      "updated": "2026-01-08T19:02:42.946Z",
      "added": "2026-01-08T19:02:42.946Z"
    }
  ]
}

Delete a transfer

delete

/ice3/o/{organizationId}/transfers/{transferId}

Delete a specific transfer

Required scopes

This endpoint requires the following scopes:

: Write/Update any data from below the organization

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23

transferIdstring · uuidRequired

The unique identifier of the transfer record

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

default

Error

application/json

delete

/ice3/o/{organizationId}/transfers/{transferId}

DELETE /v1/ice3/o/{organizationId}/transfers/{transferId} 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": [
    {
      "transferId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "competition": {
        "resourceType": "competitions",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "components": [
        {
          "personId": "text",
          "fromEntityGroupId": "text",
          "toEntityGroupId": "text",
          "extraAllowances": "Cash, 1st Round Pick"
        }
      ],
      "status": "APPROVED",
      "reference": "text",
      "transferType": "TRANSFER",
      "dateTransfer": "1978-08-24",
      "datePermitFrom": "1978-08-24",
      "datePermitTo": "1978-08-24",
      "notes": "text",
      "externalId": "A123",
      "updated": "2026-01-08T19:02:42.946Z",
      "added": "2026-01-08T19:02:42.946Z"
    }
  ]
}

PreviousSeason Teams NextAwards

Last updated 4 hours ago

Was this helpful?

Good evening

Get a list of transfers

Create a transfer

Get a transfer

Update a transfer

Delete a transfer