Subscriber List

GET

subscriber

list

Subscriber List

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

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/list', 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/subscriber/list",
  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/subscriber/list"

	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/subscriber/list")

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": [
    {
      "subscriber_id": 144,
      "chat_id": "919876543210",
      "first_name": "John",
      "last_name": "",
      "email": null,
      "gender": null,
      "assigned_agent_id": 12,
      "unseen_count": 1,
      "last_message_time": "2026-10-04 05:41:57",
      "custom_fields": "city:Mumbai,plan:Gold"
    },
    {
      "subscriber_id": 144,
      "chat_id": "919876543210",
      "first_name": "John",
      "last_name": "",
      "email": null,
      "gender": null,
      "assigned_agent_id": null,
      "unseen_count": 0,
      "last_message_time": "2026-08-15 10:56:23",
      "custom_fields": null
    }
  ],
  "nextOffset": 2
}

Lists subscribers on a WhatsApp bot.

Example Request

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

Pagination and ordering

offset is a page number, starting at 1 — it is not a count of subscribers to skip. limit is the page size (up to 100). Say you have 20 subscribers and set limit=5:

Call	offset	What you get back
1st call	`1` (or `0`)	Subscribers 1–5
2nd call	`2`	Subscribers 6–10
3rd call	`3`	Subscribers 11–15
4th call	`4`	Subscribers 16–20
5th call	`5`	Nothing — there is no fifth page

Each time, add 1 to the previous offset. The response carries nextOffset, the value to send next, and a page shorter than limit is the last one. orderBy controls which subscriber comes first:

orderBy	Result
`0` (default, or omit it)	Subscribers come back in the order they were added — oldest first
`1`	Whoever messaged most recently comes first, regardless of when they were added

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"

limit

number

required

Rows per page, up to 100.

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

orderBy

number

Set to 1 to sort by most recent message first. Set to 0 (default) for default order.

Example:

0

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.

Subscriber List

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

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/list', 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/subscriber/list",
  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/subscriber/list"

	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/subscriber/list")

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": [
    {
      "subscriber_id": 144,
      "chat_id": "919876543210",
      "first_name": "John",
      "last_name": "",
      "email": null,
      "gender": null,
      "assigned_agent_id": 12,
      "unseen_count": 1,
      "last_message_time": "2026-10-04 05:41:57",
      "custom_fields": "city:Mumbai,plan:Gold"
    },
    {
      "subscriber_id": 144,
      "chat_id": "919876543210",
      "first_name": "John",
      "last_name": "",
      "email": null,
      "gender": null,
      "assigned_agent_id": null,
      "unseen_count": 0,
      "last_message_time": "2026-08-15 10:56:23",
      "custom_fields": null
    }
  ],
  "nextOffset": 2
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Example Request

Query Parameters

Response

​Example Request

​Pagination and ordering

Query Parameters

Response

Example Request

Pagination and ordering