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

# Subscriber Get

> Look up a single subscriber by phone number via the ChatSyncs API, including assigned agent, bot/AI reply status, and labels. Use when a developer asks how to fetch a subscriber's profile programmatically.

Looks up a subscriber by their chat ID (phone number).

## Example Request

```bash theme={null}
curl --request GET \
  --url 'https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER'
```

<Warning>
  For a contact that doesn't exist the response is `{"status":"1","message":"Subscriber not found"}` — status `"1"`, and
  `message` a string instead of a list. Check that `message` is a list before reading `message[0]`.
</Warning>

A contact that has no phone number — one reached through a Meta username, for example — has a `chat_id` such as
`BD.2035698430387918` instead of digits. Pass that chat ID as `phone_number` and the lookup works.


## OpenAPI

````yaml GET /whatsapp/subscriber/get
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.


    **Authentication.** Send your key as the `apiToken` parameter, or as
    `Authorization: Bearer <key>` — both work on every endpoint **except Custom
    Fields List**, which only accepts the `apiToken` parameter (a Bearer header
    alone is answered with *The api token field is required.*). A wrong key
    returns HTTP 401 `{"status":"0","message":"Unauthenticated."}`; no key at
    all redirects to the login page.


    **Methods.** Every endpoint accepts both GET and POST with the same
    parameters, except Upload Media, which is POST-only. Use POST for anything
    that changes data.


    **Errors.** Failures usually come back as HTTP 200 with `"status":"0"` and
    the reason in `message`, so always check `status`. `status` is the string
    `"1"` or `"0"` on most endpoints and a boolean on a few.


    **Lists.** Endpoints that return rows put them in `message` as a list; there
    is no `data` field (Custom Fields List is the exception and uses `data`).
servers:
  - url: https://platform.chatsyncs.com/api/v1
security: []
paths:
  /whatsapp/subscriber/get:
    get:
      tags:
        - Subscriber API
      summary: Subscriber Get
      description: >-
        If there is no such contact the response is
        `{"status":"1","message":"Subscriber not found"}` — status `"1"`, with
        `message` a string instead of a list. Check that `message` is a list
        before reading it.
      operationId: getSubscriber
      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: phone_number
          in: query
          required: true
          schema:
            type: string
            example: PHONE-NUMBER
          description: The subscriber's phone number, with country code, digits only.
      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: array
                    description: >-
                      The rows, as a list. There is no `data` field on this
                      endpoint.
                    items:
                      type: object
              examples:
                success:
                  summary: Success
                  value:
                    status: '1'
                    message:
                      - subscriber_id: 144
                        chat_id: '919876543210'
                        first_name: John
                        last_name: ''
                        email: null
                        gender: null
                        created_at: '2026-09-19 17:35:25'
                        assigned_agent_id: 12
                        assigned_agent: Support Agent
                        bot_reply_label: Bot Reply On
                        ai_reply_label: AI Reply On
                        label_names: Label1,Label2
                        custom_fields: city:Mumbai,plan:Gold
                error:
                  summary: A required field is missing
                  value:
                    status: '0'
                    message: >-
                      The phone number id field is required., The phone number
                      field is required.
                notFound:
                  summary: Unknown contact — note status is "1"
                  value:
                    status: '1'
                    message: Subscriber not found
        '401':
          description: >-
            `apiToken` is wrong. (With no token at all the API redirects to the
            login page with HTTP 302 instead of returning JSON.)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
              examples:
                unauthenticated:
                  summary: Wrong apiToken
                  value:
                    status: '0'
                    message: Unauthenticated.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.