CRM Overview

GET

subscriber

crm

get

CRM Overview

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

const options = {method: 'GET'};

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

	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/crm/get")

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": {
    "has_deal": true,
    "deal_id": 177,
    "pipeline_id": 376,
    "pipeline_name": "Sales Pipeline",
    "stage_id": 2252,
    "stage_name": "Qualified",
    "stage_color": "#22c55e",
    "stage_type": "open",
    "title": "Schedule Appointment",
    "value": 1250.5,
    "currency": "USD",
    "expected_close_date": "2026-12-31",
    "owner_user_id": 12,
    "owner_name": "Support Agent",
    "lead_score": "warm",
    "source": "WhatsApp",
    "status": "open"
  }
}

Returns the CRM deal attached to a subscriber. It’s the way to find the pipeline_id and stage_id that Update CRM Overview takes.

Example Request

curl -X POST 'https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/crm/get' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER'

The endpoint accepts GET and POST.

Response

Unlike most read endpoints, message is an object, not a list:

{
  "status": "1",
  "message": {
    "has_deal": true,
    "deal_id": 177,
    "pipeline_id": 376,
    "pipeline_name": "Sales Pipeline",
    "stage_id": 2252,
    "stage_name": "Qualified",
    "stage_color": "#22c55e",
    "stage_type": "open",
    "title": "Schedule Appointment",
    "value": 1250.5,
    "currency": "USD",
    "expected_close_date": "2026-12-31",
    "owner_user_id": 12,
    "owner_name": "Support Agent",
    "lead_score": "warm",
    "source": "WhatsApp",
    "status": "open"
  }
}

lead_score is hot, warm or cold. owner_user_id is a team member id, and owner_name is that member’s name.

A subscriber with no deal yet answers with "has_deal": false, deal_id, title, lead_score and status all null, and the pipeline and first stage a new deal would start in (for example Sales Pipeline, stage New).

The API returns only the subscriber’s current pipeline and stage — there is no endpoint that lists a pipeline’s stages. To move a deal to another stage you need that stage’s id from your ChatSyncs dashboard, or from reading another subscriber’s deal that is already there.

An unknown subscriber is answered with {"status":"0","message":"Subscriber not found"}.

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. For a contact that has no phone number, the chat ID as Subscriber List shows it.

Example:

"PHONE-NUMBER"

Response

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

status

string

message

any

CRM Overview

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

const options = {method: 'GET'};

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

	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/crm/get")

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": {
    "has_deal": true,
    "deal_id": 177,
    "pipeline_id": 376,
    "pipeline_name": "Sales Pipeline",
    "stage_id": 2252,
    "stage_name": "Qualified",
    "stage_color": "#22c55e",
    "stage_type": "open",
    "title": "Schedule Appointment",
    "value": 1250.5,
    "currency": "USD",
    "expected_close_date": "2026-12-31",
    "owner_user_id": 12,
    "owner_name": "Support Agent",
    "lead_score": "warm",
    "source": "WhatsApp",
    "status": "open"
  }
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Example Request

Response

Query Parameters

Response

​Example Request

​Response

Query Parameters

Response

Example Request

Response