Skip to content
Optiwork API Docs

List imports

GET
/drives/{drive}/imports
curl --request GET \
  --url https://work.optidata.cloud/api/drives/1/imports \
  --header 'Authorization: Bearer <token>'

Every import of the tenant, newest first. An import is a bookkeeping record that tracks how far a bulk transfer of an external folder tree has progressed; the files themselves are created through the normal node and upload endpoints.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
drive
required
integer format: int64

Numeric id of the drive. Read it from GET /drives/config.json.

Responses

Section titled “ Responses ”

200

Section titled “200”

The imports.

Media typeapplication/json
Array<object>

Progress bookkeeping for a bulk import of an external file tree.

object
id
integer format: int64
drive_id
integer format: int64
destination_node_id
integer format: int64
origin_path

Path of the imported tree on the source system.

string
status
string
Allowed values: waiting_start running finished
total_folders_count
integer
total_files_count
integer
total_byte_size
integer format: int64
sent_folders_count
integer | null
sent_files_count
integer | null
sent_byte_size
integer | null format: int64
last_processing
string | null format: date-time
uuid
string
cuid
string
created_at
string format: date-time
updated_at
string format: date-time
Example
[
  {
    "origin_path": "D:\\Archive\\2025",
    "status": "waiting_start"
  }
]

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

404

Section titled “404”

The resource does not exist, or does not belong to the given drive.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
  "message": "No query results for model [App\\Models\\Node] 99999999"
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}