List the co-tenants and other occupants on a lease

GET

/api/leases/{leaseId}/occupants

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

• Production
• Development
• Local

Includes people who have moved out or been released from liability. People removed as entered by mistake are left out unless includeRemoved is true.

Authorizations

• bearerAuth

Parameters

Path Parameters

leaseId

required

string format: uuid

Query Parameters

includeRemoved

string

Allowed values: true false

Include people removed as entered by mistake.

Responses

200

Default Response

Media typeapplication/json

object

occupants

required

Array<object>

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

isPrimary

required

boolean

moveInDate

required

string format: date

nullable

moveOutDate

required

string format: date

nullable

notes

required

string

nullable <= 2000 characters

providerRole

required

string

nullable

relationship

required

string

nullable <= 80 characters

releasedOn

required

string format: date

nullable

removedAt

required

string format: date-time

nullable

role

required

string

Allowed values: co_tenant occupant

tenantId

required

string format: uuid

nullable

tenantName

required

string

nullable >= 1 characters <= 160 characters

Example

{
  "occupants": [
    {
      "role": "co_tenant"
    }
  ]
}

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