List units across the authenticated organization

GET

/api/units

curl --request GET \
  --url 'https://api.getvespy.com/api/units?status=occupied&sortBy=unitNumber&sortDirection=asc' \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

search

string

>= 1 characters <= 100 characters

status

string

Allowed values: occupied vacant maintenance

propertyId

string format: uuid

createdAfter

string format: date

createdBefore

string format: date

minOverdueRentCents

integer

maxOverdueRentCents

integer

minOpenWorkOrders

integer

maxOpenWorkOrders

integer

sortBy

string

Allowed values: unitNumber propertyName bedrooms bathrooms monthlyRentCents status createdAt overduePostedRentCents openWorkOrderCount

sortDirection

string

Allowed values: asc desc

Responses

200

Default Response

Media typeapplication/json

object

noteSummaries

required

Array<object>

object

entityId

required

string format: uuid

latestNote

required

object

body

required

string

>= 1 characters <= 4000 characters

createdAt

required

string format: date-time

visibility

required

string

Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared

noteCount

required

integer

units

required

Array<object>

object

accessInstructions

required

string

nullable

bathrooms

required

integer

nullable

bedrooms

required

integer

nullable

buildingId

required

string format: uuid

nullable

createdAt

required

string format: date-time

currentLease

object

endDate

required

string format: date

nullable

id

required

string format: uuid

leaseKind

string

Allowed values: residential commercial

rentCents

required

integer

>= 1

startDate

required

string format: date

status

required

string

Allowed values: draft active ended terminated

tenantId

required

string format: uuid

tenantName

required

string

>= 1 characters <= 160 characters

currentTenant

object

email

required

string format: email

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

description

required

string

nullable

floorId

required

string format: uuid

nullable

id

required

string format: uuid

monthlyRentCents

required

integer

nullable >= 1

openWorkOrderCount

integer

overduePostedRentCents

integer

propertyCity

required

string

propertyId

required

string format: uuid

propertyName

required

string

propertyPostalCode

required

string

/^\d{5}(?:-\d{4})?$/

propertyState

required

string

>= 2 characters <= 2 characters

propertyStreetLine1

required

string

>= 1 characters <= 160 characters

propertyStreetLine2

required

string

nullable >= 1 characters <= 160 characters

rentableSqft

required

integer

nullable >= 1

spaceType

required

string

Allowed values: residential_unit office_suite retail industrial storage parking other

status

required

string

Allowed values: occupied vacant maintenance

unitNumber

required

string

nullable >= 1 characters <= 32 characters

usableSqft

required

integer

nullable >= 1

Example

{
  "noteSummaries": [
    {
      "latestNote": {
        "visibility": "organization_only"
      }
    }
  ],
  "units": [
    {
      "currentLease": {
        "leaseKind": "residential",
        "status": "draft"
      },
      "spaceType": "residential_unit",
      "status": "occupied"
    }
  ]
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}