GET
/
v1
/
communications
/
groups
Lists communications groups
curl --request GET \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "48b638db-df71-4368-8d42-9dbd024a8ac1",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:09.708-07:00",
        "updated_at": "2025-09-30T11:16:09.708-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "51f3f89d-06e9-4260-8db8-63655f13e8df",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:08.730-07:00",
        "updated_at": "2025-09-30T11:16:08.730-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "2e3a02fc-1a03-4836-88eb-e7e2fb6d4819",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:07.757-07:00",
        "updated_at": "2025-09-30T11:16:07.757-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "307f0054-f3e4-49f5-aba3-437b5b8a1dba",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:06.732-07:00",
        "updated_at": "2025-09-30T11:16:06.732-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "83b47d9f-6aaf-419d-97d7-27ce42a664fa",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:05.810-07:00",
        "updated_at": "2025-09-30T11:16:05.810-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "968818d3-8e13-4f2e-9add-619af68f8392",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:04.791-07:00",
        "updated_at": "2025-09-30T11:16:04.791-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "63b6892f-ebb5-4fc5-a851-d8007e5ecc63",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:03.117-07:00",
        "updated_at": "2025-09-30T11:16:03.117-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "d97e0acc-b57f-4577-ae1c-dafd1c75f106",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:02.125-07:00",
        "updated_at": "2025-09-30T11:16:02.125-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "7a247b68-bfde-417a-94f8-e1f6bdc7783a",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [],
        "created_at": "2025-09-30T11:16:00.865-07:00",
        "updated_at": "2025-09-30T11:16:00.865-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "5c406db2-a8da-4bba-b7d1-7be3019f6ca5",
      "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": "ab63013d-3a69-44a7-b4f3-196650ac2c99",
        "slack_channel_ids": [
          "1f78b531-612a-5375-b373-2b4ed82f5c80"
        ],
        "created_at": "2025-09-30T11:15:59.885-07:00",
        "updated_at": "2025-09-30T11:15:59.885-07:00",
        "team_id": 65,
        "communication_group_members": [
          {
            "id": "234839a8-1538-4e71-a334-d0060e099963",
            "user_id": 80,
            "name": "Rosette Ward",
            "email": "ester@gulgowski.example"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "44836568-cdf8-43a0-876a-6bc2745dae86",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "e67982ef-eec0-4865-9ad9-4fc9fd0b40e7",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "0a5cf19d-3518-481f-83f7-1ed19426d8a5",
                "name": "Expedita ea delectus blanditiis."
              }
            ]
          }
        ]
      }
    }
  ],
  "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[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