Skip to main content
GET
Subscriber Get
Looks up a subscriber by their chat ID (phone number).

Example Request

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].
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.

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"

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.