Skip to main content
GET
Get link import status

Authorizations

Authorization
string
header
required

Unkey API key passed as Bearer token

Headers

X-External-User-ID
string
required

External user identifier from the calling system

X-External-User-Email
string<email>

External user email from the calling system

Path Parameters

uploadId
string<uuid>
required

Upload ID returned by POST /v1/links

Response

Link import status

uploadId
string<uuid>
required
status
enum<string>
required

Import status. Poll every few seconds while "processing".

Available options:
processing,
completed,
failed
correlationId
string<uuid>
required

Correlation ID for request tracing. Include in support requests.

finalUploadId
string<uuid>

Present when status is "completed" — the upload ID to pass in uploadIds when creating a promotion or version. May differ from the polled uploadId.

errorMessage
string

Present when status is "failed"