Skip to main content
GET
Get Copy Job

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

job_id
string<uuid>
required

Response

Successful Response

Status of a copy job.

id
string<uuid>
required

Copy job ID

status
enum<string>
required

Status of the job

Available options:
running,
completed,
failed
created
string<date-time>
required

When the job was started

progress
CopyJobProgress · object
required

How far the job has got

label
string | null

Short description of what is being copied: the item's name, or the number of items

finished_at
string<date-time> | null

When the job completed or failed

result
CopyJobResult · object | null

The outcome of the job. Set once the job completes or fails.