List conversation participants for staff inbox

GET

/api/conversations/participants

curl --request GET \
  --url 'https://api.getvespy.com/api/conversations/participants?participantType=tenant' \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Query Parameters

participantType

string

Allowed values: tenant vendor

search

string

>= 1 characters <= 100 characters

limit

integer

>= 1 <= 100

offset

integer

Responses

200

Default Response

Media typeapplication/json

object

participants

required

Array<object>

object

channels

required

Array<string>

Allowed values: in_app sms email

conversationCount

required

integer

lastMessageAt

required

string format: date-time

nullable

latestMessageChannel

required

string

nullable

Allowed values: in_app sms email

latestMessagePreview

required

string

nullable

openConversationCount

required

integer

participantEmail

required

string format: email

nullable

participantId

required

string format: uuid

participantName

required

string

>= 1 characters <= 160 characters

participantPhone

required

string

nullable

participantType

required

string

Allowed values: tenant vendor

unreadCount

required

integer

total

required

integer

unreadCount

required

integer

Example

{
  "participants": [
    {
      "channels": [
        "in_app"
      ],
      "latestMessageChannel": "in_app",
      "participantType": "tenant"
    }
  ]
}

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