Get lease by id

GET

/api/leases/{id}

curl --request GET \
  --url https://api.getvespy.com/api/leases/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

lease

required

object

createdAt

required

string format: date-time

daysUntilExpiry

required

integer

nullable

deletedAt

required

string format: date-time

nullable

endDate

required

string format: date

nullable

id

required

string format: uuid

lateFeeAmountCents

required

integer

nullable >= 1

lateFeeGraceDays

required

integer

lateFeePercentBps

required

integer

nullable >= 1

lateFeeType

required

string

Allowed values: none flat percent

moveInDate

required

string format: date

occupants

required

Array<object>

object

isPrimary

required

boolean

moveInDate

required

string format: date

nullable

moveOutDate

required

string format: date

nullable

providerRole

required

string

nullable

tenantId

required

string format: uuid

tenantName

required

string

>= 1 characters <= 160 characters

organizationId

required

string format: uuid

overduePostedRentCents

integer

propertyId

required

string format: uuid

propertyName

required

string

renewedFromLeaseId

required

string format: uuid

nullable

rentCents

required

integer

>= 1

rentChargeDay

required

integer

>= 1 <= 31

signedAt

required

string format: date-time

nullable

startDate

required

string format: date

status

required

string

Allowed values: draft active ended terminated

tenantId

required

string format: uuid

tenantName

required

string

termType

required

string

Allowed values: fixed month_to_month

terminationDate

required

string format: date

nullable

unitId

required

string format: uuid

unitNumber

required

string

nullable

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

recurringChargeRules

required

Array<object>

object

amountCents

required

integer

>= 1

categoryId

required

string format: uuid

createdAt

required

string format: date-time

dayOfMonth

required

integer

>= 1 <= 31

endDate

required

string format: date

nullable

frequency

required

string

Allowed values: monthly

id

required

string format: uuid

kind

required

string

Allowed values: rent fee

label

required

string

>= 1 characters <= 160 characters

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

propertyId

required

string format: uuid

nullable

startDate

required

string format: date

status

required

string

Allowed values: draft active paused ended

tenantId

required

string format: uuid

nullable

unitId

required

string format: uuid

nullable

updatedAt

required

string format: date-time

Example

{
  "lease": {
    "lateFeeType": "none",
    "status": "draft",
    "termType": "fixed"
  },
  "notes": [
    {
      "entityType": "property",
      "visibility": "organization_only"
    }
  ],
  "recurringChargeRules": [
    {
      "frequency": "monthly",
      "kind": "rent",
      "status": "draft"
    }
  ]
}

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