Skip to the content
Get an API key
  1. API reference
  2. Managed Transfers

Get transfer summary

GET/public/transfers/{transferUuid}
Managed TransfersAuthBasicDocsSession

The summary of one transfer of your account: status, counters, source and target service, timestamps, and resultsUrl, the address of its unmatched items. Requires Client Secret authentication, so call it only from your backend.

Path parameters

transferUuid
uuidrequired

The transferUuid from a webhook or from the Transfers page of the dashboard.

Response

200application/json · TransferSummaryResponseThe transfer summary.
transfer
TransferSummary
transfer.uuid
uuid
transfer.status
string
One of: created, fetching, running, paused, waitingForReauth, completed, completedWithErrors, failed, cancelled
transfer.options
object
The transfer options the partner configured.
transfer.counters
object
transfer.counters.total
number
transfer.counters.processed
number
transfer.counters.matched
number
transfer.counters.unmatched
number
transfer.counters.skipped
number
transfer.counters.failed
number
transfer.error
string | null
transfer.errorType
string | null
transfer.startedAt
date-time | null
transfer.finishedAt
date-time | null
transfer.createdAt
date-time
transfer.source
TransferSide
transfer.source.integrationType
string
transfer.source.name
string | null
transfer.source.email
string | null
transfer.target
TransferSide
transfer.target.integrationType
string
transfer.target.name
string | null
transfer.target.email
string | null
transfer.durationSeconds
number | null
transfer.matchRatePct
number | null
resultsUrl
uri
The address of the unmatched items of this transfer.
Example answer
{
  "transfer": {
    "uuid": "5b0c6f0e-2c8a-4d0e-9a51-7e3f1c2d9b44",
    "status": "created",
    "options": {},
    "counters": {
      "total": 0,
      "processed": 0,
      "matched": 0,
      "unmatched": 0,
      "skipped": 0,
      "failed": 0
    },
    "error": "string",
    "errorType": "string",
    "startedAt": "2026-10-16T09:41:07.000Z",
    "finishedAt": "2026-10-16T09:41:07.000Z",
    "createdAt": "2026-10-16T09:41:07.000Z",
    "source": {
      "integrationType": "spotify",
      "name": "string",
      "email": "string"
    },
    "target": {
      "integrationType": "spotify",
      "name": "string",
      "email": "string"
    },
    "durationSeconds": 0,
    "matchRatePct": 0
  },
  "resultsUrl": "https://example.com"
}

Errors

400

transferUuid is not a valid UUID.

401

The request has no credentials.

403

The request does not use Client Secret authentication, or the transfer service is not on for your account.

404

Your account has no transfer with this UUID.