Skip to content
Vespy API

Run federated search across portfolio entities

GET
/api/search
curl --request GET \
  --url 'https://api.getvespy.com/api/search?q=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
required
string
>= 1 characters <= 120 characters
types
string
>= 1 characters
limit
integer
>= 1 <= 25

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
query
required
string
>= 1 characters
results
required
Array<object>
object
id
required
string format: uuid
subtitle
required
string
>= 1 characters
title
required
string
>= 1 characters
type
required
string
Allowed values: property unit tenant lease document charge expense payment vendor work_order
url
required
string
>= 1 characters
totalHits
required
integer
Example
{
  "results": [
    {
      "type": "property"
    }
  ]
}

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