Get Conversation

GET

get

conversation

Get Conversation

curl --request GET \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "1",
  "message": [
    {
      "id": 8453,
      "whatsapp_bot_subscriber_subscriber_id": "919876543210-123",
      "whatsapp_bot_id": 123,
      "sender": "bot",
      "agent_name": "Support Agent",
      "message_content": "{\"messaging_product\":\"whatsapp\",\"to\":\"919876543210\",\"text\":{\"body\":\"Hello!\",\"preview_url\":true}}",
      "conversation_time": "2026-10-03 18:44:17",
      "wa_message_id": "wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=",
      "reaction_data": null,
      "message_status": "read",
      "delivery_status_updated_at": "2026-10-03 18:44:19",
      "read_time": "2026-10-03 18:44:32",
      "failed_time": null,
      "failed_reason": "",
      "related_id": 0
    }
  ],
  "nextOffset": 2
}

Returns the conversation history for a specific subscriber.

Example Request

curl --request GET \
  --url 'https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&limit=10&offset=1'

Pagination

offset is a page number, starting at 1 — it is not a count of messages to skip. limit is the page size (up to 50), and page 1 holds the newest messages. Say the conversation has 30 messages and you set limit=10:

Call	offset	What you get back
1st call	`1` (or `0`)	The most recent 10 messages
2nd call	`2`	The next 10, older
3rd call	`3`	The oldest 10

Each time, add 1 to the previous offset. The response carries nextOffset, the value to send next.

What comes back

Each row has a sender — user for the contact, bot for messages sent by a flow, a team member or the API, ai_agent, sequence, or system for notes such as Label added: Interested Lead. message_content is a JSON string: for messages the contact sent it is the whole WhatsApp webhook, for messages you sent it is the request that was sent, so parse it before reading it. A limit below 1 behaves as 1, a limit that isn’t a whole number is rejected (The limit must be an integer.), and past the last page you get an empty list with nextOffset null.

Query Parameters

apiToken

string

required

Your ChatSyncs API key (not a WhatsApp/Meta access token). Where to find it.

Example:

"API-KEY"

phone_number_id

string

required

The WhatsApp account's phone number ID. Where to find it.

Example:

"PHONE-NUMBER-ID"

phone_number

string

required

The subscriber's phone number, with country code, digits only.

Example:

"PHONE-NUMBER"

limit

number

required

Rows per page, up to 50.

Example:

10

offset

number

The page number, starting at 1 — not a count of rows to skip. 0 and 1 both return the first page; 2 returns the next. The response's nextOffset is the value to send next.

Example:

1

Response

Standard ChatSyncs response. status is "1" on success and "0" on failure.

status

string

"1" = success, "0" = failure.

message

object[]

The rows, as a list. There is no data field on this endpoint.

nextOffset

integer | null

The offset to send for the next page, or null on the last page.

Get Conversation

curl --request GET \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/get/conversation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "status": "1",
  "message": [
    {
      "id": 8453,
      "whatsapp_bot_subscriber_subscriber_id": "919876543210-123",
      "whatsapp_bot_id": 123,
      "sender": "bot",
      "agent_name": "Support Agent",
      "message_content": "{\"messaging_product\":\"whatsapp\",\"to\":\"919876543210\",\"text\":{\"body\":\"Hello!\",\"preview_url\":true}}",
      "conversation_time": "2026-10-03 18:44:17",
      "wa_message_id": "wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=",
      "reaction_data": null,
      "message_status": "read",
      "delivery_status_updated_at": "2026-10-03 18:44:19",
      "read_time": "2026-10-03 18:44:32",
      "failed_time": null,
      "failed_reason": "",
      "related_id": 0
    }
  ],
  "nextOffset": 2
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Example Request

What comes back

Query Parameters

Response

​Example Request

​Pagination

​What comes back

Query Parameters

Response

Example Request

Pagination

What comes back