> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chatsyncs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Subscriber List

> List all subscribers on a WhatsApp bot via the ChatSyncs API, with limit/offset pagination and an option to sort by most recent message. Use when a developer asks how to export or sync their full subscriber list.

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`:

| Call     | offset | What you get back                                                  |
| -------- | ------ | ------------------------------------------------------------------ |
| 1st call | `0`    | Subscribers 1–5                                                    |
| 2nd call | `5`    | Subscribers 6–10 — the first 5 are skipped, **not** included again |
| 3rd call | `10`   | Subscribers 11–15                                                  |
| 4th call | `15`   | Subscribers 16–20                                                  |

Each time, add `limit` to the previous `offset` to get the next page.

**`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 |


## OpenAPI

````yaml GET /whatsapp/subscriber/list
openapi: 3.1.0
info:
  title: ChatSyncs Developer API
  version: 1.0.0
  description: >-
    REST API for sending WhatsApp messages and managing subscribers through
    ChatSyncs.
servers:
  - url: https://platform.chatsyncs.com/api/v1
security: []
paths:
  /whatsapp/subscriber/list:
    get:
      tags:
        - Subscriber API
      summary: Subscriber List
      operationId: listSubscribers
      parameters:
        - name: apiToken
          in: query
          required: true
          schema:
            type: string
            example: API-KEY
          description: >-
            Your ChatSyncs API key (not a WhatsApp/Meta access token). [Where to
            find it](/developer-api/finding-ids#api-token-apitoken).
        - name: phone_number_id
          in: query
          required: true
          schema:
            type: string
            example: PHONE-NUMBER-ID
          description: >-
            The WhatsApp account's phone number ID. [Where to find
            it](/developer-api/finding-ids#phone-number-id-phone_number_id).
        - name: limit
          in: query
          required: true
          schema:
            type: number
            example: 10
          description: How many subscribers to fetch.
        - name: offset
          in: query
          required: false
          schema:
            type: number
            example: 1
          description: Pagination offset.
        - name: orderBy
          in: query
          required: false
          schema:
            type: number
            example: 0
          description: >-
            Set to 1 to sort by most recent message first. Set to 0 (default)
            for default order.
      responses:
        '200':
          description: >-
            Standard ChatSyncs response. `status` is `"1"` on success and `"0"`
            on failure.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: '`"1"` = success, `"0"` = failure.'
                  message:
                    type: string
                    description: Human-readable result message.
              examples:
                success:
                  summary: Success
                  value:
                    status: '1'
                    data:
                      - name: Rahul
                    message: Success.
                error:
                  summary: Error
                  value:
                    status: '0'
                    message: Invalid request.

````