Get all conversations within a date range

Returns conversations (grouped by contact) that had message activity within the specified date range. Designed for CRM integrations that need to pull "all chat records from the day prior" without knowing phone numbers.

GET

https://api.channelautomation.com/api/conversations/recent

Authorization

ApiKeyAuth
optional
API key in header

BearerAuth
optional
HTTP Bearer (JWT)

Query parameters

since
string
required
Start of date range (ISO 8601 or YYYY-MM-DD). Inclusive.

format: date-time
until
optional
string
End of date range (ISO 8601 or YYYY-MM-DD). Defaults to now. Exclusive.

format: date-time
format
optional
default
or
detailed
Response format:
- default: Simple text strings prefixed with "Agent:" or "Contact:"
- detailed: Full message objects with timestamp, direction, channel, and body
default: "default"
include_agent
optional
boolean
Include messages sent by human agents

default: true
include_bot
optional
boolean
Include messages sent by automations (flows, sequences, keywords)

default: true
limit
optional
integer
Maximum number of conversations (contacts) to return

maximum: 200 · minimum: 1 · default: 50
offset
optional
integer
Number of conversations to skip (for pagination)

minimum: 0 · default: 0

Header parameters

X-Workspace-Id
string
required
Workspace ID for data isolation

Returns

200

Conversations retrieved successfully

400

Invalid request parameters

401

Authentication required

JSON

error
optional
string
success
optional
boolean

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean