Skip to main content
GET
/
api
/
communication-groups
List Communication Groups
curl --request GET \
  --url https://api.embedreach.com/api/communication-groups
import requests

url = "https://api.embedreach.com/api/communication-groups"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.embedreach.com/api/communication-groups', 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://api.embedreach.com/api/communication-groups",
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://api.embedreach.com/api/communication-groups"

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://api.embedreach.com/api/communication-groups")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/communication-groups")

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
{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "id": "<string>",
        "emailChannelSenderId": "<string>",
        "emailHtmlBody": "<string>",
        "emailCompiledHtml": "<string>",
        "emailTextBody": "<string>",
        "emailPreviewText": "<string>",
        "emailSubject": "<string>",
        "smsChannelSenderId": "<string>",
        "smsMessageBody": "<string>",
        "textMessageCompanyName": "<string>",
        "updatedFromDefault": {
          "email_html_body": "<string>",
          "email_text_body": "<string>",
          "text_message_body": "<string>"
        },
        "textMessageMediaUrls": [
          "<string>"
        ],
        "extraMergeFields": [
          {
            "id": "<string>",
            "type": "static",
            "templateName": "<string>",
            "displayName": "<string>",
            "staticValue": "<string>"
          }
        ]
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "cursor": "<string>",
      "total": 123
    }
  }
}
{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}

Headers

reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Query Parameters

cursor
string

The cursor to start from

limit
number | null

The limit of items to return, default is 100

Response

Status 200 response

success
boolean
required
message
string
data
object