Skip to main content
GET
Get Conversation Messages
This single endpoint handles multiple operations via the action query parameter.

Available Actions


Action: Get Conversation Messages

Fetch messages from a specific conversation. This is the default action.

Basic Usage

Paginated Results

Search Messages by Text

Search by Shopify Order ID


Action: List Contacts

Retrieve a paginated list of all contacts for your organization.

Get All Contacts

Paginated Contacts

Search Contacts by Name/Phone


Action: Find Contact by Phone

Look up a specific contact using their phone number.
Phone numbers are automatically normalized, so +27 12 345 6789 and 27123456789 will find the same contact.

Reference Tables

Message Sender Types

Message Status

Media Types

Bot Status Values

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: Bearer YOUR_BEARER_TOKEN

Query Parameters

action
enum<string>
default:conversation-messages

API action to perform

Available options:
conversation-messages,
contacts,
find-by-phone
whatsappNumber
string

WhatsApp phone number (required for message and find-by-phone actions)

contactId
string<uuid>

Contact UUID (alternative to whatsappNumber)

limit
integer
default:10

Number of items per page (messages: default 10, contacts: default 50)

Required range: 1 <= x <= 100
page
integer
default:1

Page number for pagination

Required range: x >= 1
query
string

Search terms (comma-separated for multiple terms)

orderId
string

Shopify order ID to search for (fetches order number from Shopify)

ascending
boolean
default:false

Message order (false = newest first, true = oldest first)

Search contacts by name/phone (for contacts action)

Response

Successful response

success
boolean
required

Whether the request was successful

Example:

true

messages
object[]
required

Array of conversation messages

count
integer
required

Number of messages returned in this response

Required range: x >= 0
Example:

10

filtered
boolean
required

Whether search filtering was applied

Example:

true

pagination
object
searchTerms
string[] | null

Search terms that were applied (if any)

Example:
stored
boolean

Whether messages were stored in contact record

Example:

false