Skip to content
Vespy API

List tenant invites

GET
/api/tenant-invites
curl --request GET \
  --url 'https://api.getvespy.com/api/tenant-invites?status=pending' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
tenantId
string format: uuid
status
string
Allowed values: pending accepted expired

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
invites
required
Array<object>
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
Example
{
  "invites": [
    {
      "status": "pending"
    }
  ]
}

400

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}