Get unit by id

GET

/api/units/{id}

curl --request GET \
  --url https://api.getvespy.com/api/units/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

feeTemplates

required

Array<object>

object

amountCents

required

integer

>= 1

categoryId

required

string format: uuid

createdAt

required

string format: date-time

defaultDueDay

required

integer

nullable >= 1 <= 31

id

required

string format: uuid

label

required

string

>= 1 characters <= 160 characters

organizationId

required

string format: uuid

unitId

required

string format: uuid

updatedAt

required

string format: date-time

notes

required

Array<object>

object

body

required

string

>= 1 characters <= 4000 characters

createdAt

required

string format: date-time

createdByUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

createdByUserId

required

string format: uuid

nullable

entityId

required

string format: uuid

entityType

required

string

Allowed values: property unit owner tenant lease vendor work_order

id

required

string format: uuid

visibility

required

string

Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared

unit

required

object

accessInstructions

required

string

nullable

bathrooms

required

integer

bedrooms

required

integer

createdAt

required

string format: date-time

currentLease

object

endDate

required

string format: date

nullable

id

required

string format: uuid

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

id

required

string format: uuid

monthlyRentCents

required

integer

>= 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

status

required

string

Allowed values: occupied vacant maintenance

unitNumber

required

string

nullable >= 1 characters <= 32 characters

Example

{
  "notes": [
    {
      "entityType": "property",
      "visibility": "organization_only"
    }
  ],
  "unit": {
    "currentLease": {
      "status": "draft"
    },
    "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"
}

404

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