Skip to main content
GET
/
v1
/
communications
/
groups
Lists communications groups
curl --request GET \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "07955783-ce8c-4e0d-9734-9950c6b718fe",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 10",
        "slug": "communication-group-10",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:38.168-08:00",
        "updated_at": "2025-11-27T00:06:38.168-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "a2a2aabc-b454-4b49-af22-ba871f273212",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 9",
        "slug": "communication-group-9",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:37.313-08:00",
        "updated_at": "2025-11-27T00:06:37.313-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "2f2b8b79-b896-434b-a9c9-d57a81dda314",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 8",
        "slug": "communication-group-8",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:36.411-08:00",
        "updated_at": "2025-11-27T00:06:36.411-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "458dbf93-6100-407f-9b56-03f7e7fc1f97",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 7",
        "slug": "communication-group-7",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:35.569-08:00",
        "updated_at": "2025-11-27T00:06:35.569-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "dbaeebff-1b3f-4866-958c-5b611d756755",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 6",
        "slug": "communication-group-6",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:34.689-08:00",
        "updated_at": "2025-11-27T00:06:34.689-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "31419a14-feea-433e-86a8-d3c9b1dc0ebe",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 5",
        "slug": "communication-group-5",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:33.681-08:00",
        "updated_at": "2025-11-27T00:06:33.681-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "2efc9e9c-18a3-427a-be81-d1923fc9a8b1",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 4",
        "slug": "communication-group-4",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:32.855-08:00",
        "updated_at": "2025-11-27T00:06:32.855-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "5e003134-d605-4b94-ade9-16fe7f7ef0d5",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 3",
        "slug": "communication-group-3",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:31.934-08:00",
        "updated_at": "2025-11-27T00:06:31.934-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "c7591b8d-5346-41c2-bcc5-aab018fafbe9",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 2",
        "slug": "communication-group-2",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [],
        "created_at": "2025-11-27T00:06:30.433-08:00",
        "updated_at": "2025-11-27T00:06:30.433-08:00",
        "team_id": 110,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "fdb8551d-ec57-4aea-8eaa-689d144d6ddf",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 1",
        "slug": "communication-group-1",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "4cc3f907-34bb-4ea0-8df3-5924414678b2",
        "slack_channel_ids": [
          "5c8e0c0f-637b-5a66-8d7b-dfb2b1c9d994"
        ],
        "created_at": "2025-11-27T00:06:29.536-08:00",
        "updated_at": "2025-11-27T00:06:29.536-08:00",
        "team_id": 110,
        "communication_group_members": [
          {
            "id": "25e72bad-f068-4ec1-be1d-d7460cb8a367",
            "user_id": 109,
            "name": "Deb Smith",
            "email": "britt@terry.test"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "fbe8ff40-dab6-4cfb-9268-f7338c17d167",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "8923159f-6430-423a-a39c-78eb0a6e0cc3",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "8e5ae257-2d38-4eb3-afcd-d48b8be2b78a",
                "name": "Nisi et incidunt quos."
              }
            ]
          }
        ]
      }
    }
  ],
  "links": {
    "self": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "first": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "prev": null,
    "next": null,
    "last": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  },
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_count": 10,
    "total_pages": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page[number]
integer
​
page[size]
integer
​
filter[search]
string
​
filter[name]
string
​
filter[slug]
string
​
filter[is_private]
string
​
filter[communication_type_id]
string
​
filter[condition_type]
string
​
filter[created_at][gt]
string
​
filter[created_at][gte]
string
​
filter[created_at][lt]
string
​
filter[created_at][lte]
string
​
sort
string

Response

200 - application/vnd.api+json

communications groups found

​
data
object[]
required
​
links
object