Skip to content
BoxBilling

Get data export

GET
/v1/data_exports/{export_id}

Get a data export by ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
export_id
required
Export Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

DataExportResponse

Schema for data export response.

object
id
required
Id
string format: uuid
organization_id
required
Organization Id
string format: uuid
export_type
required
Export Type
string
status
required
Status
string
filters
Any of:
object
key
additional properties
any
file_path
Any of:
string
record_count
Any of:
integer
progress
Any of:
integer
error_message
Any of:
string
started_at
Any of:
string format: date-time
completed_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time

401

Section titled “401 ”

Unauthorized

404

Section titled “404 ”

Data export not found

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object