MEmentium
conversations

List Conversations

Changed on

List conversations with optional filters and search.

NOTE: when no status filter is provided the default response hides rows with status="FAILED" — these are audit-only pre-flight / provider-rejected compose attempts. To see them, pass status=FAILED explicitly.

Each row adds ai_agent_name, direction (who wrote first) and, in carrier_offers, the latest offer with its rates, currency and load.

get/v2/conversations/

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

workspace_idstring required
statusstring nullable
load_idstring nullable

Filter by the thread's TMS load: its own external_reference_load_id or its offers' load

labelstring nullable

Filter conversations that have this label

has_draftsboolean nullable

Only conversations with a draft message

has_sentboolean nullable

Only conversations that have outbound messages

is_starredboolean nullable

Only starred conversations

channelstring nullable

Filter by channel: email | sms | whatsapp, or several comma-separated

qstring nullable

Search the subject, participants, each message's sender and subject, and the carrier name, email and load of the thread's offers (case-insensitive)

search_bodyboolean

Also search the plain-text message bodies with q (slower)

limitinteger
offsetinteger
thread_directionstring nullable

Who wrote first: all | inbound (the carrier) | outbound (us). When set, it replaces the legacy folder rule that the default view keeps only threads with a carrier message.

start_datetimestring date-time nullable

Last message at or after this instant

end_datetime_exclusivestring date-time nullable

Last message before this instant

ai_agent_idstring[] nullable

Only threads handled by one of these AI agents

outcomestring nullable

The row's outcome pill: failed | ai_handling | booked | accepted | declined | negotiating | completed. The call-only outcomes (transferred, no_answer, stale, live, in_progress) match no thread.

filters_jsonstring nullable

JSON array of record filters: [{"field": "carrier_id", "operator": "IN", "values": ["C-1"]}, {"field": "resource", "operator": "EQUALS", "resource_type": "Load", "identifier_field": "external_reference_id", "value": "484612"}, {"field": "load.origin_state", "operator": "IN", "values": ["TX"]}]. carrier_id and the load id match the thread's own reference or any of its offers'; a load id may be the TMS display reference. load.* fields are those Calls filters on, answered by the TMS for the 5,000 most recently active loads of the matching threads.

Headers

mentium-workspace-idstring nullable

Response

Successful Response

unknown required

Changes