API Reference

Get Conversations

get
https://api.vcita.biz/platform/v1/conversations

Overview

Gets a list of conversations.

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…
Query Params
integer

Page number of results. Default: 1

integer

How many items to return per page. Default: 25. Max: 100

string
enum

Filter conversations by folder. Only honored for staff (user) tokens; admin/app/directory tokens silently ignore this parameter. Unknown values silently fall through to unfiltered results. (e.g., "inbox", "follow_up", "sent", "archived", "attention", "trash", "all")

Allowed:
Headers
string

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

Response

Updated 2 days 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 days ago