API Reference

Get Conversation Messages

get
https://api.vcita.biz/v2/conversations//messages

Overview

Retrieves a paginated list of messages within a specific conversation. Messages are returned in chronological order and include staff details, document attachments, and delivery status.

Available for Staff and Directory tokens. Directory tokens require the X-On-Behalf-Of header with the target business UID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier (UID) of the conversation to retrieve messages from.

Query Params
integer

Page number of results. Default: 1

integer

How many items to return per page. Default: 20

boolean

If set, returns only messages updated in the last minute. Useful for polling for new messages.

string

When set to 'me', filters messages to only those visible to the current staff member's team view.

Headers
string

Business UID to act on behalf of. Required for Directory tokens.

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago