List security deposits

GET

/api/trust/deposits

curl --request GET \
  --url 'https://api.getvespy.com/api/trust/deposits?status=held' \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

leaseId

string format: uuid

tenantId

string format: uuid

bankAccountId

string format: uuid

status

string

Allowed values: held partially_returned returned forfeited

isOverdue

boolean

Responses

200

Default Response

Media typeapplication/json

object

securityDeposits

required

Array<object>

object

amountCents

required

integer

>= 1

bankAccountId

required

string format: uuid

nullable

createdAt

required

string format: date-time

id

required

string format: uuid

isOverdue

required

boolean

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

propertyState

required

string

nullable

receivedAt

required

string format: date-time

returnDeadline

required

string format: date-time

nullable

returnDeadlineDays

required

integer

nullable

returnedAt

required

string format: date-time

nullable

status

required

string

Allowed values: held partially_returned returned forfeited

tenantId

required

string format: uuid

nullable

updatedAt

required

string format: date-time

Example

{
  "securityDeposits": [
    {
      "status": "held"
    }
  ]
}

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