GET
/
api
/
communication-groups
List Communication Groups
curl --request GET \
  --url https://api.embedreach.com/api/communication-groups
{
  "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>",
        "extraMergeFields": [
          {
            "id": "<string>",
            "type": "static",
            "templateName": "<string>",
            "displayName": "<string>",
            "staticValue": "<string>"
          }
        ],
        "updatedFromDefault": {
          "email_html_body": "<string>",
          "email_text_body": "<string>",
          "text_message_body": "<string>"
        },
        "textMessageMediaUrls": [
          "<string>"
        ],
        "type": "custom"
      }
    ],
    "pagination": {
      "total": 123,
      "hasNextPage": true,
      "cursor": "<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

200
application/json

Status 200 response

The response is of type object.