Skip to main content
GET
Follow a URL import

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer yk_live_…. Scopes: transfers:read, transfers:write, collections:read, collections:write, contacts:read, contacts:write, webhooks:read, webhooks:write. A write scope implies read of the same resource.

Path Parameters

fileId
string
required

The fileId from an imports entry in a create response.

Response

The import's status.

Where one import stands.

fileId
string
required
name
string
required
size
integer
required
Required range: x >= 0
receivedBytes
integer
required

Committed so far. Moves in steps of one storage part (32 MB or more).

Required range: x >= 0
source
string | null
required
status
string
required

Currently one of: importing, ready, failed. Treat unknown values as unknown, not as an error.

error
string | null
required

Why it failed, when it did.