Skip to content
Vespy API

Search messages

GET
/api/messages/search
curl --request GET \
  --url 'https://api.getvespy.com/api/messages/search?channel=in_app&participantType=tenant' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string
>= 2 characters <= 100 characters
channel
string
Allowed values: in_app sms email
participantType
string
Allowed values: tenant vendor
from
string format: date-time
to
string format: date-time
limit
integer
>= 1 <= 50
offset
integer

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
results
required
Array<object>
object
conversationStatus
required
string
Allowed values: open closed archived
conversationSubject
required
string
nullable
message
required
object
body
required
string
>= 1 characters <= 5000 characters
channel
required
string
Allowed values: in_app sms email
conversationId
required
string format: uuid
createdAt
required
string format: date-time
emailMessageId
required
string
nullable
externalId
required
string
nullable
fromAddress
required
string
nullable
id
required
string format: uuid
metadata
required
object
key
additional properties
any
organizationId
required
string format: uuid
senderId
required
string format: uuid
nullable
senderName
required
string
nullable
senderType
required
string
Allowed values: staff tenant vendor system
smsSid
required
string
nullable
toAddresses
required
Array<string>
nullable
participantId
required
string format: uuid
participantName
required
string
>= 1 characters <= 160 characters
participantType
required
string
Allowed values: tenant vendor
total
required
integer
Example
{
  "results": [
    {
      "conversationStatus": "open",
      "message": {
        "channel": "in_app",
        "senderType": "staff"
      },
      "participantType": "tenant"
    }
  ]
}

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