Skip to main content
GET
/
whatsapp
/
subscriber
/
list
Subscriber List
curl --request GET \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/list
import requests

url = "https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/list"

response = requests.get(url)

print(response.text)
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))

}
HttpResponse<String> response = Unirest.get("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/list")
  .asString();
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",
  "data": [
    {
      "name": "Rahul"
    }
  ],
  "message": "Success."
}
Lists subscribers on a WhatsApp bot.

​
Pagination and ordering

offset skips that many subscribers before it starts returning results. Say you have 20 subscribers and set limit=5:
CalloffsetWhat you get back
1st call0Subscribers 1–5
2nd call5Subscribers 6–10 — the first 5 are skipped, not included again
3rd call10Subscribers 11–15
4th call15Subscribers 16–20
Each time, add limit to the previous offset to get the next page. orderBy controls which subscriber comes first:
orderByResult
0 (default, or omit it)Subscribers come back in the order they were added — oldest first
1Whoever 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

How many subscribers to fetch.

Example:

10

​
offset
number

Pagination offset.

Example:

1

​
orderBy
number

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

Example:

0

Response

200 - application/json

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

​
status
string

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

​
message
string

Human-readable result message.