Skip to content

List bulk imports

GET
/api/imports
curl --request GET \
--url https://api.getvespy.com/api/imports \
--header 'Authorization: Bearer <token>'

Default Response

Media typeapplication/json
object
imports
required
Array<object>
object
bundleId
required
string format: uuid
nullable
completedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
errorMessage
required
string
nullable
fileName
required
string
>= 1 characters
id
required
string format: uuid
mapping
required
object
key
additional properties
string
organizationId
required
string format: uuid
providerResourceKind
required
string
nullable
requestedByUserId
required
string format: uuid
resourceType
required
string
Allowed values: property unit owner tenant lease vendor charge payment expense expense_payment
sourceFileId
required
string format: uuid
nullable
sourceNamespace
required
string
>= 1 characters <= 80 characters
stage
required
integer
nullable >= 1 <= 6
startedAt
required
string format: date-time
nullable
status
required
string
Allowed values: validating ready queued processing completed completed_with_errors failed
summary
required
object
created
required
integer
duplicatesMerged
required
integer
failedResources
required
integer
failedRows
required
integer
totalResources
required
integer
totalRows
required
integer
unchanged
required
integer
updated
required
integer
validRows
required
integer
Example
{
"imports": [
{
"resourceType": "property",
"status": "validating"
}
]
}

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
"code": "example",
"errors": [
{
"code": "example",
"message": "example",
"path": "example"
}
],
"message": "example"
}

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
"code": "example",
"errors": [
{
"code": "example",
"message": "example",
"path": "example"
}
],
"message": "example"
}