Skip to content
Vespy API

List bulk import resource definitions

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
resources
required
Array<object>
object
columns
required
Array<object>
object
aliases
required
Array<string>
description
required
string
>= 1 characters
key
required
string
>= 1 characters
label
required
string
>= 1 characters
required
required
boolean
label
required
string
>= 1 characters
requiresExternalId
required
boolean
type
required
string
Allowed values: property unit owner tenant lease vendor charge payment expense expense_payment
Example
{
  "resources": [
    {
      "type": "property"
    }
  ]
}

401

Section titled “401”

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"
}

403

Section titled “403”

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"
}