Validate tenant invite token

GET

/api/tenant-invites/{token}

curl --request GET \
  --url https://api.getvespy.com/api/tenant-invites/example

• Production
• Development
• Local

Parameters

Path Parameters

token

required

string

>= 1 characters <= 255 characters

Responses

200

Default Response

Media typeapplication/json

object

invite

required

object

acceptedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

createdByUserId

required

string format: uuid

nullable

email

required

string format: email

expiresAt

required

string format: date-time

id

required

string format: uuid

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

revokedAt

required

string format: date-time

nullable

status

required

string

Allowed values: pending accepted expired

tenantId

required

string format: uuid

token

required

string

lease

required

object

coTenantsJointlyLiable

required

boolean

nullable

createdAt

required

string format: date-time

daysUntilExpiry

required

integer

nullable

deletedAt

required

string format: date-time

nullable

effectiveDate

required

string format: date

nullable

endDate

required

string format: date

nullable

executedDate

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

leaseKind

required

string

Allowed values: residential commercial

moveInDate

required

string format: date

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

organizationId

required

string format: uuid

overduePostedRentCents

integer

propertyId

required

string format: uuid

propertyName

required

string

renewedFromLeaseId

required

string format: uuid

nullable

rentCents

required

integer

rentChargeDay

required

integer

>= 1 <= 31

rentCommencementCondition

required

string

nullable >= 1 characters <= 500 characters

rentCommencementDate

required

string format: date

nullable

scheduledBaseRentAsOf

string format: date

nullable

scheduledBaseRentCents

integer

nullable

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

tenant

required

object

billingAddress

required

object

city

required

string

>= 1 characters <= 120 characters

country

required

string

>= 2 characters <= 2 characters

line1

required

string

>= 1 characters <= 160 characters

line2

string

nullable >= 1 characters <= 160 characters

postalCode

required

string

>= 1 characters <= 20 characters

state

required

string

>= 1 characters <= 80 characters

createdAt

required

string format: date-time

dbaName

required

string

nullable

deletedAt

required

string format: date-time

nullable

email

required

string format: email

nullable

emergencyContactName

required

string

nullable

emergencyContactPhone

required

string

nullable

emergencyContactRelationship

required

string

nullable

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

isActive

required

boolean

kind

required

string

Allowed values: person company

legalName

required

string

nullable

organizationId

required

string format: uuid

phone

required

string

nullable

preferredLanguage

required

string

>= 2 characters <= 32 characters

userId

required

string format: uuid

nullable

Example

{
  "invite": {
    "status": "pending"
  },
  "lease": {
    "lateFeeType": "none",
    "leaseKind": "residential",
    "occupants": [
      {
        "role": "co_tenant"
      }
    ],
    "status": "draft",
    "termType": "fixed"
  },
  "tenant": {
    "kind": "person"
  }
}

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

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